Class DescriptionFragmentLibrary

Index

Constructors

Methods

getFragment combineFragments addFragments

Constructors

constructor

new DescriptionFragmentLibrary(chance?: Chance): DescriptionFragmentLibrary
Parameters
- Optionalchance: Chance
Returns DescriptionFragmentLibrary
- Defined in core/DescriptionFragmentLibrary.ts:27

Methods

getFragment

getFragment(
eventType: string,
fragmentType: "opening" | "middle" | "closing" | "standalone",
): Fragment | null
Get a random fragment of a specific type for an event type
Parameters
- eventType: string
- fragmentType: "opening" | "middle" | "closing" | "standalone"
Returns Fragment | null
- Defined in core/DescriptionFragmentLibrary.ts:241

combineFragments

combineFragments(
    subject: string,
    adjective: string,
    eventType: string,
    options?: {
        useOpening?: boolean;
        useMiddle?: boolean;
        useClosing?: boolean;
    },
): string
Combine fragments into a complete description
Parameters
- subject: string
- adjective: string
- eventType: string
- Optionaloptions: { useOpening?: boolean; useMiddle?: boolean; useClosing?: boolean }
Returns string
- Defined in core/DescriptionFragmentLibrary.ts:255

addFragments

addFragments(
    eventType: string,
    fragments: {
        openings?: Fragment[];
        middles?: Fragment[];
        closings?: Fragment[];
        standalones?: Fragment[];
    },
): void
Add custom fragments
Parameters
- eventType: string
- fragments: {
      openings?: Fragment[];
      middles?: Fragment[];
      closings?: Fragment[];
      standalones?: Fragment[];
  }
Returns void
- Defined in core/DescriptionFragmentLibrary.ts:328