eigengraus-essential-establishment-generator

find: (word: string) => undefined | string

• • (word: string): undefined | string

  • Parameters

    • word: string

    Returns undefined | string

output: (word: string, upper?: boolean) => string

• • (word: string, upper?: boolean): string

  • Parameters

    • word: string

    • Optional upper: boolean

    Returns string

override: (article: string, word: string, caseSensitive?: boolean) => undefined | "cannot add article override -> invalid word" | "cannot add article override -> invalid article, must be \"a\" or \"an\""

• • (article: string, word: string, caseSensitive?: boolean): undefined | "cannot add article override -> invalid word" | "cannot add article override -> invalid article, must be \"a\" or \"an\""

  • Must be called in story JS or StoryInit, as the override map isn't stateful.

    Parameters

    • article: string

    • word: string

    • Optional caseSensitive: boolean

    Returns undefined | "cannot add article override -> invalid word" | "cannot add article override -> invalid article, must be \"a\" or \"an\""

arms: { descriptions: string[] }

• descriptions: string[]

head: { chin: string[]; ears: string[]; eyes: string[]; hair: string[]; misc: string[]; mouth: string[]; nose: string[] }

• chin: string[]

• ears: string[]

• eyes: string[]

• hair: string[]

• misc: string[]

• mouth: string[]

• nose: string[]

legs: { descriptions: string[] }

• descriptions: string[]

torso: { descriptions: string[] }

• descriptions: string[]

inverse: (npc: NPC, key: string) => string

• • (npc: NPC, key: string): string

  • Parameters

    • npc: NPC

    • key: string

    Returns string

nouns: Record<string, string>

verbose: (key: string) => string

• • (key: string): string

  • Parameters

    • key: string

    Returns string

flower: { bush: string[]; stemP: string[]; stemS: string[] }

• bush: string[]

• stemP: string[]

• stemS: string[]

fruit: { fruitP: string[]; fruitS: string[]; tree: string[] }

• fruitP: string[]

• fruitS: string[]

• tree: string[]

tree: { typeArticle: string[]; typeS: string[] }

• typeArticle: string[]

• typeS: string[]

vegetable: { vegetableP: string[]; vegetableS: string[] }

• vegetableP: string[]

• vegetableS: string[]

man: { boygirl: "boy"; childNoun: "son"; domTitle: "Master"; godgoddess: "god"; guygirl: "guy"; heshe: "he"; himher: "him"; himherself: "himself"; hisher: "his"; hisherself: "hisself"; malefemale: "male"; manwoman: "man"; marriageNoun: "husband"; menwomen: "men"; niblingNoun: "nephew"; niblingReciprocalNoun: "uncle"; oppositeGender: "woman"; parentNoun: "father"; siblingNoun: "brother"; title: "Mr" }

• boygirl: "boy"

• childNoun: "son"

• domTitle: "Master"

• godgoddess: "god"

• guygirl: "guy"

• heshe: "he"

• himher: "him"

• himherself: "himself"

• hisher: "his"

• hisherself: "hisself"

• malefemale: "male"

• manwoman: "man"

• marriageNoun: "husband"

• menwomen: "men"

• niblingNoun: "nephew"

• niblingReciprocalNoun: "uncle"

• oppositeGender: "woman"

• parentNoun: "father"

• siblingNoun: "brother"

• title: "Mr"

woman: { boygirl: "girl"; childNoun: "daughter"; domTitle: "Mistress"; godgoddess: "goddess"; guygirl: "girl"; heshe: "she"; himher: "her"; himherself: "herself"; hisher: "her"; hisherself: "herself"; malefemale: "female"; manwoman: "woman"; marriageNoun: "wife"; menwomen: "women"; niblingNoun: "niece"; niblingReciprocalNoun: "aunt"; oppositeGender: "man"; parentNoun: "mother"; siblingNoun: "sister"; title: "Ms" }

• boygirl: "girl"

• childNoun: "daughter"

• domTitle: "Mistress"

• godgoddess: "goddess"

• guygirl: "girl"

• heshe: "she"

• himher: "her"

• himherself: "herself"

• hisher: "her"

• hisherself: "herself"

• malefemale: "female"

• manwoman: "woman"

• marriageNoun: "wife"

• menwomen: "women"

• niblingNoun: "niece"

• niblingReciprocalNoun: "aunt"

• oppositeGender: "man"

• parentNoun: "mother"

• siblingNoun: "sister"

• title: "Ms"

crud: string[]

get: { customers: ({ base: undefined; relationshipDescription: string; relationships: { associatedNPC: { reciprocalRelationship: string; relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any } | { base: { profession: string }; relationshipDescription: string; relationships: { associatedNPC: { reciprocalRelationship: string; relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any })[]; note: any; priceTalk: any; say: any; shopkeepNote: any }

• customers: ({ base: undefined; relationshipDescription: string; relationships: { associatedNPC: { reciprocalRelationship: string; relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any } | { base: { profession: string }; relationshipDescription: string; relationships: { associatedNPC: { reciprocalRelationship: string; relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any })[]

• note: function

  • note(generalStore: GeneralStore): string

  • Parameters

    • generalStore: GeneralStore

    Returns string

• priceTalk: function

  • priceTalk(generalStore: GeneralStore): { priceModifier: number; priceTalk: string; wealth: number }[]

  • Parameters

    • generalStore: GeneralStore

    Returns { priceModifier: number; priceTalk: string; wealth: number }[]

• say: function

  • say(generalStore: GeneralStore): string

  • Parameters

    • generalStore: GeneralStore

    Returns string

• shopkeepNote: function

  • shopkeepNote(generalStore: GeneralStore): string

  • Parameters

    • generalStore: GeneralStore

    Returns string

goods: { cleaning supplies: string[]; fabrics: string[]; food staples: string[]; luxuries: string[]; tools: string[] }

• cleaning supplies: string[]

• fabrics: string[]

• food staples: string[]

• luxuries: string[]

• tools: string[]

idle: string[]

rollData: { activity: { description: string; hasRolls: boolean; preceding: string }; cleanliness: { description: string; preceding: string; rolls: ThresholdTable<string> }; expertise: { description: string; isHidden: boolean; preceding: string; rolls: ThresholdTable<string> }; magic: { description: string; hasRolls: boolean; preceding: string }; priceModifier: { description: string; hasRolls: boolean; preceding: string }; reputation: { description: string; hasRolls: boolean; preceding: string }; size: { description: string; preceding: string; rolls: ThresholdTable<string> }; wealth: { description: string; preceding: string; rolls: ThresholdTable<string> } }

• activity: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• cleanliness: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

• expertise: { description: string; isHidden: boolean; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • isHidden: boolean

  • preceding: string

  • rolls: ThresholdTable<string>

• magic: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• priceModifier: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• reputation: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• size: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

• wealth: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

evidenceLocker: { items: { function: any }[] }

• items: { function: any }[]

get: { customers: ({ base: { profession: string; professionSector: undefined }; relationshipDescription: string; relationships: { associatedNPC: { relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any } | { base: { profession: undefined; professionSector: string }; relationshipDescription: string; relationships: { associatedNPC: { relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any })[]; event: (town: Town, guardhouse: Guardhouse) => { function: any }[]; holdingCell: { base?: undefined | Partial<NPC>; reason: string }[]; officeDescription: (guardhouse: Guardhouse) => { description: string; size: number; wealth: number }[]; officeItems: string[] }

• customers: ({ base: { profession: string; professionSector: undefined }; relationshipDescription: string; relationships: { associatedNPC: { relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any } | { base: { profession: undefined; professionSector: string }; relationshipDescription: string; relationships: { associatedNPC: { relationship: string }; building: { reciprocalRelationship: string; relationship: string } }; description: any })[]

• event: (town: Town, guardhouse: Guardhouse) => { function: any }[]

  • • (town: Town, guardhouse: Guardhouse): { function: any }[]

    • example

      `At the moment, ______

      Parameters

      • town: Town

      • guardhouse: Guardhouse

      Returns { function: any }[]

• holdingCell: { base?: undefined | Partial<NPC>; reason: string }[]

• officeDescription: (guardhouse: Guardhouse) => { description: string; size: number; wealth: number }[]

  • • (guardhouse: Guardhouse): { description: string; size: number; wealth: number }[]

    • Parameters

      • guardhouse: Guardhouse

      Returns { description: string; size: number; wealth: number }[]

• officeItems: string[]

name: { adjective: string[]; wordNoun: string[] }

• adjective: string[]

• wordNoun: string[]

notableFeature: { exclusions?: any; function: any }[]

rollData: { activity: { description: string; hasRolls: boolean; preceding: string }; cleanliness: { description: string; preceding: string; rolls: ThresholdTable<string> }; expertise: { description: string; preceding: string; rolls: ThresholdTable<string> }; magic: { description: string; hasRolls: boolean; preceding: string }; reputation: { description: string; hasRolls: boolean; preceding: string }; size: { description: string; preceding: string; rolls: ThresholdTable<string> }; wealth: { description: string; preceding: string; rolls: ThresholdTable<string> } }

• activity: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• cleanliness: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

• expertise: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

• magic: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• reputation: { description: string; hasRolls: boolean; preceding: string }

  • description: string

  • hasRolls: boolean

  • preceding: string

• size: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

• wealth: { description: string; preceding: string; rolls: ThresholdTable<string> }

  • description: string

  • preceding: string

  • rolls: ThresholdTable<string>

equalTo: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

largerThan: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

largerThanOrEqualTo: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

notEqualTo: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

smallerThan: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

smallerThanOrEqualTo: <T>(value: number, map: Record<number, T>, defaultValue?: T) => undefined | T

• • <T>(value: number, map: Record<number, T>, defaultValue?: T): undefined | T

  • Type parameters

    • T

    Parameters

    • value: number

    • map: Record<number, T>

    • Optional defaultValue: T

    Returns undefined | T

create: (base?: Partial<Medal>) => Medal

• • (base?: Partial<Medal>): Medal

  • Parameters

    • Optional base: Partial<Medal>

    Returns Medal

Brugo Gul'Moth: { age: string; ageYears: number; background: string; backgroundOrigin: string; beard: string; calmTrait: string; eyes: string; familyUnit: string; firstName: string; gender: string; hairColour: string; hairType: string; hasClass: boolean; height: string; heightInches: number; idle: string[]; inventory: string; isThrowaway: boolean; lastName: string; name: string; note: string; parentalLineage: string; physicalTrait: string; profession: string; professionOrigin: string; race: string; scar: string; stressTrait: string; trait: string; vocalPattern: string; weight: string; weightPounds: number }

• age: string

• ageYears: number

• background: string

• backgroundOrigin: string

• beard: string

• calmTrait: string

• eyes: string

• familyUnit: string

• firstName: string

• gender: string

• hairColour: string

• hairType: string

• hasClass: boolean

• height: string

• heightInches: number

• idle: string[]

• inventory: string

• isThrowaway: boolean

• lastName: string

• name: string

• note: string

• parentalLineage: string

• physicalTrait: string

• profession: string

• professionOrigin: string

• race: string

• scar: string

• stressTrait: string

• trait: string

• vocalPattern: string

• weight: string

• weightPounds: number

Galder Fendt: { age: string; ageYears: number; background: string; beard: string; calmTrait: string; eyes: string; firstName: string; gender: string; hairColour: string; hasClass: boolean; height: string; heightInches: number; idle: never[]; isThrowaway: boolean; lastName: string; name: string; note: string; physicalTrait: string; profession: string; race: string; scar: string; stressTrait: string; trait: string; vocalPattern: string; weight: string }

• age: string

• ageYears: number

• background: string

• beard: string

• calmTrait: string

• eyes: string

• firstName: string

• gender: string

• hairColour: string

• hasClass: boolean

• height: string

• heightInches: number

• idle: never[]

• isThrowaway: boolean

• lastName: string

• name: string

• note: string

• physicalTrait: string

• profession: string

• race: string

• scar: string

• stressTrait: string

• trait: string

• vocalPattern: string

• weight: string

Tylien Birchbottom: { age: string; ageYears: number; background: string; backgroundOrigin: string; calmTrait: string; firstName: string; gender: string; greeting: string[]; hairColour: string; hairType: string; hasClass: boolean; height: string; heightInches: number; idle: string[]; isThrowaway: boolean; lastName: string; note: string; owner: string; physicalTrait: string; profession: string; professionOrigin: string; race: string; scar: string; stressTrait: string; trait: string; vocalPattern: string; weight: string }

• age: string

• ageYears: number

• background: string

• backgroundOrigin: string

• calmTrait: string

• firstName: string

• gender: string

• greeting: string[]

• hairColour: string

• hairType: string

• hasClass: boolean

• height: string

• heightInches: number

• idle: string[]

• isThrowaway: boolean

• lastName: string

• note: string

• owner: string

• physicalTrait: string

• profession: string

• professionOrigin: string

• race: string

• scar: string

• stressTrait: string

• trait: string

• vocalPattern: string

• weight: string

assign: (town: Town, building?: Building) => Road

• • (town: Town, building?: Building): Road

  • Adds checks for road duplication; use this one for assigning to randomly generated buildings.

    Parameters

    • town: Town

    • Optional building: Building

    Returns Road

create: (town: Town, opts?: Partial<Road>) => Road

• • (town: Town, opts?: Partial<Road>): Road

  • Creates the road

    Parameters

    • town: Town

    • Optional opts: Partial<Road>

    Returns Road

features: string[]

get: { features: any }

• features: function

  • features(type: RoadData): string

  • Parameters

    • type: RoadData

    Returns string

material: { types: Record<RoadMaterialType, RoadMaterial>; exclusions: any; get: any }

• types: Record<RoadMaterialType, RoadMaterial>

• exclusions: function

  • exclusions(town: Town, arg: MaterialType): boolean

  • Parameters

    • town: Town

    • arg: MaterialType

    Returns boolean

• get: function

  • get(town: Town, road: Road): MaterialType

  • Parameters

    • town: Town

    • road: Road

    Returns MaterialType

name: { type: Record<RoadType, RoadData>; create: any }

• type: Record<RoadType, RoadData>

• create: function

  • create(town: Town): RoadOwnership

  • Parameters

    • town: Town

    Returns RoadOwnership

namesakes: { reason: any }

• reason: function

  • reason(town: Town, namesake: Namesake): string

  • Parameters

    • town: Town

    • namesake: Namesake

    Returns string

precedingText: { default: any; isTheRoad: any }

• default: function

  • default(town: Town, road: Road): string

  • Parameters

    • town: Town

    • road: Road

    Returns string

• isTheRoad: function

  • isTheRoad(town: Town, road: Road, overrides?: { after: string[]; pre: string[] }): string

  • Parameters

    • town: Town

    • road: Road

    • Optional overrides: { after: string[]; pre: string[] }

      • after: string[]

      • pre: string[]

    Returns string

width: { capacity: number[][]; largeRoads: string[]; rolls: ThresholdTable<string>; getCapacity: any }

• capacity: number[][]

• largeRoads: string[]

• rolls: ThresholdTable<string>

• getCapacity: function

  • getCapacity(road: Road): number

  • Parameters

    • road: Road

    Returns number

colour: string[]

material: { rollData: { wealth: { rolls: ThresholdTable<string> } }; types: Record<string, MaterialType> }

• rollData: { wealth: { rolls: ThresholdTable<string> } }

  • wealth: { rolls: ThresholdTable<string> }

    • rolls: ThresholdTable<string>

• types: Record<string, MaterialType>

rollData: { size: { rolls: ThresholdTable<string> } }

• size: { rolls: ThresholdTable<string> }

  • rolls: ThresholdTable<string>

roof: { colour: string[]; rollData: { wealth: { rolls: ThresholdTable<string> } }; types: Record<string, RoofType> }

• colour: string[]

• rollData: { wealth: { rolls: ThresholdTable<string> } }

  • wealth: { rolls: ThresholdTable<string> }

    • rolls: ThresholdTable<string>

• types: Record<string, RoofType>

viceKey: { arbitrary: string; cowardly: string; cruel: string; deceitful: string; indulgent: string; lazy: string; lustful: string; proud: string; reckless: string; selfish: string; suspicious: string; vengeful: string; worldly: string }

• arbitrary: string

• cowardly: string

• cruel: string

• deceitful: string

• indulgent: string

• lazy: string

• lustful: string

• proud: string

• reckless: string

• selfish: string

• suspicious: string

• vengeful: string

• worldly: string