MATTIE.eventAPI

The main API the modding engine uses to perform any actions regarding events
This api is mostly for runtime events, if you want to add new compile time events look at loading data assets.

Members

static dataEvents
commonLibs/_common/API_CORE/eventHooks.js, line 3

an array storing all active map events

static dataEvents
commonLibs/_common/API_CORE/eventWrapper.js, line 27

an array storing all active map events

static orgSetupEvent
commonLibs/_common/API_CORE/eventHooks.js, line 7

the base setup events function

Methods

static addItemDropToCurrentMap(item)
commonLibs/_common/API_CORE/eventAPI.js, line 13

Parameters:
Name Type Description
item Game_Item

static createBlankEvent()
commonLibs/_common/API_CORE/eventAPI.js, line 34

create a blank event

Returns:
-

the id of the event

static createEnemyFromExisting(mapId, eventId, alivePageId, deadPageId)
commonLibs/_common/API_CORE/eventAPI.js, line 176

create an enemy from an existing enemy handling death with a self switch
the self switch "A" will be used for the death page
the self switch "B" is used to signal if the player is in combat with it or not

Parameters:
Name Type Description
mapId *

the map of the original enemy
eventId *

the id of the original enemy
alivePageId *

the alive page of the original enemy
deadPageId *

the dead page of the original enemy

static getEventOnMap(id, mapId) → {rm.types.Event}
commonLibs/_common/API_CORE/eventAPI.js, line 134

get a Game event obj from id and map id

Parameters:
Name Type Description
id int

event id
mapId int

mapid
Returns:
rm.types.Event