Namespaces

actors

MATTIE.static.actors

commands

MATTIE.static.commands

commonEvents

MATTIE.static.commonEvents

events

MATTIE.static.events

items

MATTIE.static.items

maps

MATTIE.static.maps

rpg

MATTIE.static.rpg

skills

MATTIE.static.skills

states

MATTIE.static.states

switch

MATTIE.static.switch

variable

MATTIE.static.variable

Members

static _activeModule :Object|null

game-modules/_gameModuleLoader.js, line 39

The currently active game module, set after selection and application.

static _registeredModules :Array.<Object>

game-modules/_gameModuleLoader.js, line 33

All registered game modules. Populated by calls to registerGameModule().

static teleports

commonLibs/_common/static.js, line 174

used by the cheat menu to teleport to key points

Methods

static _applyGameModule(module)

game-modules/_gameModuleLoader.js, line 131

Apply a game module's data into MATTIE.static.* namespaces.
Called automatically by MATTIE.static.update() when a module is selected.

Parameters:

Name	Type	Description
module	Object	The game module to apply.

static _selectGameModule() → {Object|null}

game-modules/_gameModuleLoader.js, line 110

Find the first registered module whose versionMatch() returns true.

Returns:

Object | null -

The matching module, or null if none found.

static rangeParser()

commonLibs/_common/static.js, line 351

this function takes an array of ints and strings, the strings must be in the format "int-int" as a range of ints,
this function then changes those strings of ranges into the ints themselves and returns the value.

Returns:

-

array

static registerGameModule(module)

game-modules/_gameModuleLoader.js, line 87

Register a game module with the engine.
Each module must provide at minimum: id, name, versionMatch.

Full interface contract:
{
id: string, // e.g. "fearandhunger1"
name: string, // e.g. "Fear & Hunger"
versionMatch: function() -> boolean, // returns true when this game is running

actors: { mercenaryId, girlId, ... },
maps: { menuMaps, blockingMaps, charCreationMap, startMap, fortress, ... },
teleports: [ { id, name, cmd, bool, btn }, ... ],
switches: {
ignored, synced, syncedSelfSwitches, ignoredSelfSwitches,
characterLimbs, logical, hardMode, starvation,
crowMaulerCanSpawn, crowMaulerDead, crowMaulerDisabled, ...
},
variables: { ignored, synced, secondarySynced, godAffinityAndPrayerVars, ... },
states: { knockout, resistDeath, armCut, legCut, bleeding, ... },
troops: { crowMauler, ... },
items: function($dataItems) -> { emptyScroll, silverCoin, icons },
skills: function($dataSkills) -> { hurting, ... },
commonEvents: { smallFood, medFood, largeFood, lootTables, ... },
events: { images: { shiny, coin }, crowMauler },

multiplayer: {
ghost: { mapId, eventId, troopId, troopIndex },
pvpActorTroopMap: { [actorId]: troopId },
gameOverText: { death, place, spectate, rebirth },
spawnMap: { mapId, x, y },
charPortraitMap: { [actorId]: faceName },
},

features: { hasCrowMauler, hasLighting },
compat: { blockedMods, ignoredPlugins, menuIconMap },
hooks: { onStaticUpdate, onMultiplayerInit },
dependencies: [], // commonLib paths to load, e.g. "_common/betterCrowMauler"
}

Parameters:

Name	Type	Description
module	Object	The game module to register