Global

Methods

callCreate(functionName, argsopt) → {*}

Description:

• Dynamically imports the module for a create* function and invokes it with args. Runs identically on the main thread or inside a worker.

Source:

• worker/registry.js, line 27

Parameters:

Returns:

Type

*

callExpand(guid) → {Object|null}

Description:

• Expands a shimmed location (see createLocation's shim option) in place, by guid. Must run in the same worker that originally created the location, since it looks up the live location object (and its LocationTemplate) by guid in that worker's registries.

Source:

• worker/registry.js, line 52

Parameters:

Returns:

Type

Object | null

callGetLocation(guid) → {Object|null}

Description:

• Looks up the canonical location object by guid, without expanding a shim.

Source:

• worker/registry.js, line 64

Parameters:

Returns:

Type

Object | null

callRegisterLocations(locations)

Description:

• Repopulates the worker's location registries from a previously-generated location tree (or array of trees) — see registerLocations' own doc comment for why this is needed.

Source:

• worker/registry.js, line 75

Parameters:

(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 347

Example

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

Parameters:

Returns:

Type

String

createBag(paramsopt) → {Bag}

Description:

• Creates a collection of objects, held in a collection type known as a Bag.

Source:

• create_bag.js, line 81

Example

createBag({ count: 3, tags: "house"}).toString()
=> "A television (5/20), a winter jacket (worn; 0.5/10), and a ceramic bowl (3/1)."

Parameters:

Returns:

Type

Bag

createBookTitle(optionsopt) → {string}

Description:

• Generates a random fictional book title, optionally filtered by genre.

Source:

• create_book_title.js, line 41

Parameters:

Returns:

Type

string

createCharacter(options) → {Character}

Description:

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

Source:

• create_character.js, line 150

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 54

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

createContainer(optionsopt) → {Bag}

Description:

• Creates a container (e.g., a first aid kit, cabinet, or ammunition box) of a given type, potentially pre-filled with items. Containers may be empty or show signs of prior use.

Source:

• create_container.js, line 74

Parameters:

Returns:

Type

Bag

createEventLayer(options) → {void}

Description:

• Enriches a location map with event-driven narrative content. Compared to the historical layer generator, this one is programmatic because the content is more difficult to integrate.

Source:

• create_event_layer.js, line 18

Parameters:

Returns:

Type

void

createFamily(optionsopt) → {Family}

Description:

• Creates a multi-generational family with characters, relationships, and a shared family name. The family tree simulates births, deaths, and partnerships over time. A generation is counted when a child is born into the tree.

Source:

• create_family.js, line 180

Parameters:

Returns:

Type

Family

createGang(optionsopt) → {Gang}

Description:

• Creates a gang of characters with a shared type, name, and profession-appropriate traits. Each member is a generated Character. Members may be assigned nicknames depending on gang type.

Source:

• create_gang.js, line 105

Parameters:

Returns:

Type

Gang

createHistoricalLayer(options) → {void}

Description:

• Enriches a location map with pre-collapse historical narrative content. Selects locations and modifies them according to history rules: adding descriptions, renaming locations, placing items or containers, and optionally clearing their existing contents.

Source:

• create_historical_layer.js, line 55

Parameters:

Returns:

Type

void

createHorse(optionsopt) → {string}

Description:

• Generates a descriptive string for a horse, including its type, optional behavior, coat pattern, and name.

Source:

• create_animal.js, line 64

Parameters:

Returns:

Type

string

createItem(optionsopt) → {Item}

Description:

• Creates a random item from the item database, optionally filtered by name, tags, value range, or encumbrance range. Automatically generates titles for books, magazines, and horses.

Source:

• create_item.js, line 41

Parameters:

Returns:

Type

Item

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 62

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 89

createLocationName(optionsopt) → {string}

Description:

• Generates a name for a location node based on its type and its position in the location hierarchy. Supports sequence-based naming (e.g. "Room 1", "Room 2") and type-specific name generation (e.g. street names, building names, geographic features).

Source:

• create_location_name.js, line 462

Parameters:

Returns:

Type

string

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 181

Returns:

Type

String

createMap(optionsopt) → {Map}

Description:

• Fetches an SVG topo map from url, extracts its embedded site/label metadata (via parseSvgMetadata — no DOMParser, so this runs in the worker like every other generator), and generates a shimmed Location for every marker. Returns a Map model carrying every generated Location plus the ordered marker instructions a renderer needs to place them on the SVG.

Source:

• create_map.js, line 18

Parameters:

Returns:

Type

Map

createMapEnrichment()

Description:

• Should be called after all locations have been created in a context, preferably in the worker thread, to enrich the locations after initial presentation. The GUIDS of enriched locations are returned and from there, they can be retrieved via getLocation.

  Takes the full list of locations involved (registerLocations() runs first, as this function's own first step) so callers never have to sequence registration before enrichment themselves — safe to call unconditionally whether or not this worker instance created these locations itself (re-registering an already-registered location is a harmless no-op, same object reference).

Source:

• create_location.js, line 71

createMemorabilia(optionsopt) → {Item}

Description:

• Creates a random piece of pre-collapse memorabilia, such as a comic book, trading card, magazine, or movie poster.

Source:

• create_memorabilia.js, line 893

Parameters:

Returns:

Type

Item

createProfession(optionsopt) → {Profession}

Description:

• Looks up a profession from the profession database by name or tags.

Source:

• create_profession.js, line 29

Parameters:

Returns:

Type

Profession

createRelationship(optionsopt) → {Relationship}

Description:

• Creates a pair of related characters (e.g. mother and son, aunt and nephew) with appropriate age differences, shared or independent heritage, and related professions.

Source:

• create_relationship.js, line 101

Parameters:

Returns:

Type

Relationship

createTimeSeries(options) → {Array.<string>}

Description:

• Generates a series of publication dates for a periodical, within a historical date range. Useful for assigning realistic issue dates to magazines and newspapers.

Source:

• create_time_series.js, line 78

Parameters:

Returns:

Type

Array.<string>

createWeather(optionsopt) → {Weather}

Description:

• Creates a weather report for a given date and location, including temperature, wind, precipitation, sun/moon times, and game-relevant effects (cold/heat warnings, travel impacts).

Source:

• create_weather.js, line 188

Parameters:

Returns:

Type

Weather

createWorkerClient() → {Promise.<{call: function(), expand: function(), terminate: function()}>}

Description:

• Returns the shared client that runs create* functions (and other worker-side operations) in a separate thread — a Web Worker in the browser, or a worker_threads Worker in Node — via Comlink. Environment is detected automatically so the same call site works in both.

  The underlying worker is created once and reused by every caller: worker-side module state (e.g. the location template registry used to expand shimmed locations) must stay consistent across calls, so different parts of the app can't each get their own worker.

Source:

• worker/worker_client.js, line 20

Example

const client = await createWorkerClient();
const location = await client.call("createLocation", { type: "Farm", history: true });
await client.terminate();

Returns:

Type

Promise.<{call: function(), expand: function(), terminate: function()}>

newLocation(template, parent) → {Location}

Description:

• Create a location based on a location template. The location constructor follows model conventions and takes a params object, so the copy operation must happen outside of it, and this is the method to do that.

Source:

• models/location.js, line 74

Parameters:

Returns:

Type

Location

parseSvgMetadata()

Description:

• Extracts the handful of attributes createMap() needs from a topo-map SVG's raw text, with no DOM/DOMParser involved — this must run in a Web Worker or Node worker_threads thread, neither of which has DOMParser. #polygons is parsed (so its escaped data-points JSON attribute is exercised) but intentionally discarded — see notes/Programming/specs/2026-08-03-createmap-topo-refactor-design.md.

Source:

• svg_metadata.js, line 31

registerLocations()

Description:

• Repopulates LOCATIONS_BY_GUID from a previously-generated location tree (or array of trees) — the only worker-side registry that needs rehydrating after a reload, since templates are now derived by type (see expandLocation). Used when loading a saved map: its locations were generated (and possibly enriched) in a prior session/worker instance, so this worker's registries start out empty for those guids.

Source:

• create_location.js, line 50

toLastNameString() → {String}

Source:

• models/character_name.js, line 51

Returns:

Type

String

toString() → {String}

Source:

• models/character_name.js, line 57

Returns:

Type

String