Global

Methods

addToSequence(props, id, alias)

Description:

• Add or append to a sequence in the props object. If a sequence with the given id exists, append the alias to its options. Otherwise, create a new sequence with the id and alias.

Source:

• data_loaders.js, line 189

Parameters:

captureInlineSequence(element) → {Object}

Description:

• Parse an element that may contain 'as' syntax (e.g., 'Living Room as "Parlor"'). Returns an object with the type and optional alias.

Source:

• data_loaders.js, line 129

Parameters:

Returns:

Type

Object

(static) createAppearance(character) → {String}

Description:

• Describe a character's appearance and behavior. This description will be different each time the character is passed to this function.

Source:

• create_appearance.js, line 344

Example

createAppearance({ character })
=> "Long brown hair, short stature"

Parameters:

Returns:

Type

String

createBag(paramsopt)

Description:

• Generate a collection of items.

Source:

• create_bag.js, line 107

Example

let bag = createBag({ totalValue: 500, minValue: 10, tags: 'firearm'});
bag.toString()
=> "2 Browning Automatic Rifles, a M14 Rifle...and a pulse rifle."

Parameters:

createCharacter(options) → {Character}

Description:

• Creates a new character with customizable attributes and generated characteristics.

Source:

• create_character.js, line 136

Parameters:

Returns:

Type

Character

createCharacterName(params) → {CharacterName}

Description:

• Generate a random name for a mid-century American, of the kind that would be wandering around an atomic era apocalypse. Does not add a nickname.

Source:

• create_character_name.js, line 46

Example

createCharacterName({gender: 'female', heritage: 'latino'})
=> {"given": "Elena", "family": "Silva", "gender": "female", "heritage": "latino"}
let girl = createCharacterName({gender: 'female'})
girl.toString()
=> "Ada King"

Parameters:

Returns:

Type

CharacterName

createKit(params) → {Object}

Description:

• Generate the possessions that would be on the person of an active NPC (e.g. out on patrol, out for a night on the town, out on a raid or in the middle of criminal activity).

Source:

• create_kit.js, line 55

Parameters:

Returns:

Type

Object

createLocation()

Description:

• Create a location. You must supply the type of a location template and an instance tree will be created from that point in the template hierarchy, working downward throw all child nodes templates, returning the resulting instance tree. Tags are not currently used in selection of templates, but may be in the future.

Source:

• create_location.js, line 66

createMagazineTitle() → {String}

Description:

• Magazines will be produced as generic items in bags, loot, etc. This method returns a magazine with an auto-generated title, usually pretty silly. The titles are random so these magazines are not considered collectible.

Source:

• create_magazine_title.js, line 269

Returns:

Type

String

createStockpile(paramsopt) → {Bag}

Description:

• Like creating a bag but with many more repeated items (purposefully repeated, not accidentally repeated), as if collected for a cache, shop, or storeroom. Honors the totalValue limit (in fact will usually fall short of it), but fillBag will always be treated as false.

Source:

• create_bag.js, line 153

Parameters:

Returns:

Type

Bag

findAll(optionsopt) → {Array.<Item>}

Description:

• Finds all items matching the specified criteria.

Source:

• db/item_database.js, line 82

Example

itemDb.findAll({ tags: "weapon sword", minValue: 10, maxValue: 100 });

Parameters:

Returns:

Type

Array.<Item>

findAll(param) → {Array.<Model>}

Description:

• This returns all items that match regardless of rarity, or an empty array if none match.

Source:

• db/rarity_database.js, line 42

Parameters:

Returns:

Type

Array.<Model>

findOne(optionsopt) → {Item|null}

Description:

• Finds a single random item matching the specified criteria, weighted by rarity (rare items are less likely to be selected).

Source:

• db/item_database.js, line 118

Example

itemDb.findOne({ tags: "weapon", minValue: 5 });

Parameters:

Returns:

Type

Item | null

findOne(param) → {Model|null}

Description:

• This returns one random item that matches, respecting rarity.

Source:

• db/rarity_database.js, line 53

Parameters:

Returns:

Type

Model | null

idFilter(m, id) → {boolean}

Description:

• Filters models by ID.

Source:

• db/database.js, line 88

Example

models.filter(m => idFilter(m, "item123"));

Parameters:

Returns:

Type

boolean

namesFilter(m, name) → {boolean}

Description:

• Filters models by checking if a name exists in the model's names array.

Source:

• db/database.js, line 130

Example

models.filter(m => namesFilter(m, "John"));

Parameters:

Returns:

Type

boolean

newCreateBag(paramsopt) → {Bag}

Description:

• A simplified bag creation algorithm. Create a bag by iteratively adding items until constraints are met.

Source:

• create_bag.js, line 208

Parameters:

Returns:

Type

Bag

parseList(line) → {Object}

Description:

• Parse a list of elements, returning both the list and any 'as' aliases found. The aliases are returned separately so they can be used to create sequences.

Source:

• data_loaders.js, line 144

Parameters:

Returns:

Type

Object

tagFilter(m, tags) → {boolean}

Description:

• Filters models by tags using tag matching logic.

Source:

• db/database.js, line 116

Example

models.filter(m => tagFilter(m, "weapon firearm"));

Parameters:

Returns:

Type

boolean

timeSeries(paramsopt) → {Array}

Description:

• Create a date series for periodicals, in the past.

Source:

• historical_time_series.js, line 72

Parameters:

Returns:

Type

Array

typeFilter(m, type) → {boolean}

Description:

• Filters models by type (case-insensitive).

Source:

• db/database.js, line 102

Example

models.filter(m => typeFilter(m, "weapon"));

Parameters:

Returns:

Type

boolean