Methods

addCommand(pageId, command, parameters)

commonLibs/_common/API_CORE/eventWrapper.js, line 224

Parameters:

Name	Type	Description
pageId	*
command	*
parameters	*

addCommandAfterIndex(index, command, pageIndex)

commonLibs/_common/API_CORE/eventWrapper.js, line 458

add

Parameters:

Name	Type	Description
index	*	the index in the list of commands to add this command after
command	*	the command obj to add
pageIndex	int	the page index of the page to add the command to

addMoveRoute(pageId, route)

commonLibs/_common/API_CORE/eventWrapper.js, line 127

add the move route command to a page

Parameters:

Name	Type	Description
pageId	*	the id of the page to add the command to
route	*	the id of the action

addPage()

commonLibs/_common/API_CORE/eventWrapper.js, line 76

Add a new page for the event's actions.

addSpokenText(pageId, text)

commonLibs/_common/API_CORE/eventWrapper.js, line 117

add text command to page with a speaker

Parameters:

Name	Type	Description
pageId	*
text	*

addSpriteToTilemap(sprite)

commonLibs/_common/API_CORE/eventWrapper.js, line 329

Add a sprite to the current scene's Tilemap.

Parameters:

Name	Type	Description
sprite		(Sprite_Character)

addText(pageId, text)

commonLibs/_common/API_CORE/eventWrapper.js, line 107

add text command to page

Parameters:

Name	Type	Description
pageId	*
text	*

addTintScreen(pageId, tint, frames)

commonLibs/_common/API_CORE/eventWrapper.js, line 137

Parameters:

Name	Type	Description
pageId	*	the page Id to add the command to
tint	*	the tint object
frames	*	who many frames to tint for

addWait(pageId, frames)

commonLibs/_common/API_CORE/eventWrapper.js, line 170

add a wait command to a page

Parameters:

Name	Type	Description
pageId	*	the page id to add the command to
frames	*	the number of frames to wait

checkSelfSwitch(letter) → {boolean}

commonLibs/_common/API_CORE/eventWrapper.js, line 472

check a self switch of this event

Parameters:

Name	Type	Description
letter	*	the letter of the self switch

Returns:

boolean -

whether the switch is true or false

copyActionsFromCommonEvent(id)

commonLibs/_common/API_CORE/eventWrapper.js, line 391

Copy actions from a Common Event with the specified id.

Parameters:

Name	Type	Description
id		(int)

copyActionsFromEvent(id)

commonLibs/_common/API_CORE/eventWrapper.js, line 348

Copy actions from another event on the same map with the specified id.

Parameters:

Name	Type	Description
id		(int)

copyActionsFromEventOnMap(id, mapId)

commonLibs/_common/API_CORE/eventWrapper.js, line 359

Copy actions from another event on map with the specified id.

Parameters:

Name	Type	Description
id		(int)
mapId		(int)

Returns:

-

self for cmd chaining

createCharacterSprite(event)

commonLibs/_common/API_CORE/eventWrapper.js, line 312

Create a new Sprite_Character and store it in the current scene's Spriteset_Map.

Parameters:

Name	Type	Description
event		(Game_Event)

Returns:

-

the event or an empty event if something went wrong

createCommand(command, parameters, indent) → {rm.types.Event}

commonLibs/_common/API_CORE/eventWrapper.js, line 235

create a command obj from these params

Parameters:

Name	Type	Default	Description
command	*		the command code
parameters	*		array of params
indent	*	0	optional

Returns:

rm.types.Event

createGameEvent()

commonLibs/_common/API_CORE/eventWrapper.js, line 300

Create a new Game_Event object and store it in $gameMap.

getLastEvent()

commonLibs/_common/API_CORE/eventWrapper.js, line 293

Get the last Event object stored in $dataMap.

getListOfCommandCodesOnPage(page)

commonLibs/_common/API_CORE/eventWrapper.js, line 438

return an array of all command codes on page

Parameters:

Name	Type	Description
page	*	page index

indexOfCommandOnPage(commandCode, page)

commonLibs/_common/API_CORE/eventWrapper.js, line 447

returns the index of the first occurence of the command code on the page

Parameters:

Name	Type	Description
commandCode	*	command code
page	*	page index

setChar(pageId, name)

commonLibs/_common/API_CORE/eventWrapper.js, line 214

change the charecter of a page

Parameters:

Name	Type	Description
pageId	*
name	string	string

setDefaultConditions()

commonLibs/_common/API_CORE/eventWrapper.js, line 145

Set the default event conditions for a page of actions.

setDefaultMoveRoute()

commonLibs/_common/API_CORE/eventWrapper.js, line 247

Set the default move route for a page of actions.

setDefaultPage()

commonLibs/_common/API_CORE/eventWrapper.js, line 84

Returns:

-

the default page objectt

setId()

commonLibs/_common/API_CORE/eventWrapper.js, line 54

Automatically set the id for the event.

setImage(pageId, imageObj)

commonLibs/_common/API_CORE/eventWrapper.js, line 205

change the image of a page

Parameters:

Name	Type	Description
pageId	*
imageObj	*

setName(name)

commonLibs/_common/API_CORE/eventWrapper.js, line 266

Set the name of the event.

Parameters:

Name	Type	Description
name		(string)

setNote(note)

commonLibs/_common/API_CORE/eventWrapper.js, line 275

Set the note of the event.

Parameters:

Name	Type	Description
note		(string)

setPosition(x, y)

commonLibs/_common/API_CORE/eventWrapper.js, line 285

Set the map coordinates of the event.

Parameters:

Name	Type	Description
x		(int)
y		(int)

spawn(x, y)

commonLibs/_common/API_CORE/eventWrapper.js, line 404

Place the event on the map at the specified coordinates.

Parameters:

Name	Type	Description
x		(int)
y		(int)

static generateImage(index, name, dir, pattern, tile)

commonLibs/_common/API_CORE/eventWrapper.js, line 190

Parameters:

Name	Type	Description
index	*	the index of the char, 3 cols per index
name	*	the name of the char sheet to use
dir	*	the dir they are facing, 2,4,6,8
pattern	*
tile	*	tile id not sure

Returns:

-

obj

static setDefaultImage()

commonLibs/_common/API_CORE/eventWrapper.js, line 177

Set the default event image for a page of actions.