Class: Game_Interpreter

Game_Interpreter

new Game_Interpreter()

The interpreter for running event commands.

Methods

changeHp(target, value, allowDeath)

Change hp of a target
NameTypeDescription
targetGame_BattlerThe target
valuenumberThe value to change the hp by
allowDeathbooleanAllow the target to die by this operation?
Get the character by param
NameTypeDescription
paramnumbernegative for player, 0 for the event id
Returns:
TypeDescription
Game_Character|nullThe character or null if not found

checkFreeze()boolean

Check for freeze
Returns:
TypeDescription
booleanTrue if frozen

checkOverflow()

Check the interpreter for overflow
Throws:
Error if depth is greater than or equal to 100
Clear the interpreter variables

command101(params)boolean

Handling for the Show Text command
NameTypeDescription
paramsArrayA list of command parameters. 0 = filename, 1 = file index, 2 = background type, 3 = position type, 4 = name
Returns:
TypeDescription
booleanTrue if command succeeded

command102(params)boolean

Handling for the Show Choices command
NameTypeDescription
paramsArrayA list of command parameters. 0 = choice array, 1 = cancel, 2 = default, 3 = position type, 4 = background type
Returns:
TypeDescription
booleanTrue if command succeeded

command103(params)boolean

Handling for the Input Number command
NameTypeDescription
paramsArrayA list of command parameters. 0 = variable id, 1 = number of digits
Returns:
TypeDescription
booleanTrue if command succeeded

command104(params)boolean

Handling for the Select Item command
NameTypeDescription
paramsArrayA list of command parameters. 0 = variable id, 1 = item type
Returns:
TypeDescription
booleanTrue if command succeeded

command105(params)boolean

Handling for the Scrolling Text command
NameTypeDescription
paramsArrayA list of command parameters. 0 = speed, 1 = no fast forward setting
Returns:
TypeDescription
booleanTrue if command succeeded

command108(params)boolean

Handling for the Comment command
NameTypeDescription
paramsArrayA list of command parameters. 0 = The comment text (first line), subsequent lines stored in command 408
Returns:
TypeDescription
booleanTrue if command succeeded

command109()boolean

Handling for the Skip command
Since:
  • Version 1.5.0
Returns:
TypeDescription
booleanTrue if command succeeded

command111(params)boolean

Handling for the Conditional Branch command
NameTypeDescription
paramsArrayA list of command parameters. 0 = condition type, other values vary by type.
Returns:
TypeDescription
booleanTrue if command succeeded

command112()boolean

Handling for the Loop command
Returns:
TypeDescription
booleanTrue if command succeeded

command113()boolean

Handling for the Break Loop command
Returns:
TypeDescription
booleanTrue if command succeeded

command115()boolean

Handling for the Exit Event Processing command
Returns:
TypeDescription
booleanTrue if command succeeded

command117(params)boolean

Handling for the Common Event command
NameTypeDescription
paramsArrayA list of command parameters. 0 = common event id
Returns:
TypeDescription
booleanTrue if command succeeded

command118()boolean

Handling for the Label command
Returns:
TypeDescription
booleanTrue if command succeeded

command119(params)boolean

Handling for the Jump to Label command
NameTypeDescription
paramsArrayA list of command parameters. 0 = label name
Returns:
TypeDescription
booleanTrue if command succeeded

command121(params)boolean

Handling for the Control Switches command
NameTypeDescription
paramsArrayA list of command parameters. 0 = first switch id in range, 1 = last switch id in range, 2 = enable/disable value
Returns:
TypeDescription
booleanTrue if command succeeded

command122(params)boolean

Handling for the Control Variables command
NameTypeDescription
paramsArrayA list of command parameters. 0 = start variable id, 1 = end variable id, 2 = operation type, 3 = operand, 4/5/6 = data values, some types do not use indexes 5 or 6.
Returns:
TypeDescription
booleanTrue if command succeeded

command123(params)boolean

Handling for the Control Self Switch command
NameTypeDescription
paramsArrayA list of command parameters. 0 = switch id, 1 = enable/disable value
Returns:
TypeDescription
booleanTrue if command succeeded

command124(params)boolean

Handling for the Control Timer command
NameTypeDescription
paramsArrayA list of command parameters. 0 = start or stop, 1 = time (if start)
Returns:
TypeDescription
booleanTrue if command succeeded

command125(params)boolean

Handling for the Change Gold command
NameTypeDescription
paramsArrayA list of command parameters. 0 = operation, 1 = operand type, 2 = operand value
Returns:
TypeDescription
booleanTrue if command succeeded

command126(params)boolean

Handling for the Change Items command
NameTypeDescription
paramsArrayA list of command parameters. 0 = item id, 1 = operation, 2 = operand type, 3 = operand value
Returns:
TypeDescription
booleanTrue if command succeeded

command127(params)boolean

Handling for the Change Weapons command
NameTypeDescription
paramsArrayA list of command parameters. 0 = weapon id, 1 = operation, 2 = operand type, 3 = operand value, 4 = include equip
Returns:
TypeDescription
booleanTrue if command succeeded

command128(params)boolean

Handling for the Change Armors command
NameTypeDescription
paramsArrayA list of command parameters. 0 = armor id, 1 = operation, 2 = operand type, 3 = operand value, 4 = include equip
Returns:
TypeDescription
booleanTrue if command succeeded

command129(params)boolean

Handling for the Change Party Member command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = operation, 2 = initialize flag
Returns:
TypeDescription
booleanTrue if command succeeded

command132(params)boolean

Handling for the Change Battle BGM command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe bgm filename
params[].volumenumberThe bgm volume
params[].pitchnumberThe bgm pitch
params[].pannumberThe bgm pan
Returns:
TypeDescription
booleanTrue if command succeeded

command133(params)boolean

Handling for the Change Victory ME command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe me filename
params[].volumenumberThe me volume
params[].pitchnumberThe me pitch
params[].pannumberThe me pan
Returns:
TypeDescription
booleanTrue if command succeeded

command134(params)boolean

Handling for the Change Save Access command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enable/disable
Returns:
TypeDescription
booleanTrue if command succeeded

command135(params)boolean

Handling for the Change Menu Access command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enable/disable
Returns:
TypeDescription
booleanTrue if command succeeded

command136(params)boolean

Handling for the Change Encounter command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enable/disable
Returns:
TypeDescription
booleanTrue if command succeeded

command137(params)boolean

Handling for the Change Formation Access command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enable/disable
Returns:
TypeDescription
booleanTrue if command succeeded

command138(params)boolean

Handling for the Change Window Color command
NameTypeDescription
paramsArrayA list of command parameters. 0 = Red, 1 = Green, 2 = Blue
Returns:
TypeDescription
booleanTrue if command succeeded

command139(params)boolean

Handling for the Change Defeat ME command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe me filename
params[].volumenumberThe me volume
params[].pitchnumberThe me pitch
params[].pannumberThe me pan
Returns:
TypeDescription
booleanTrue if command succeeded

command140(params)boolean

Handling for the Change Vehicle BGM command
NameTypeDescription
paramsArrayA list of command parameters. 0 = vehicle type, 1 = bgm properties
Returns:
TypeDescription
booleanTrue if command succeeded

command201(params)boolean

Handling for the Transfer Player command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = map id, 2 = x, 3 = y, 4 = direction, 5 = fade type
Returns:
TypeDescription
booleanTrue if command succeeded

command202(params)boolean

Handling for the Set Vehicle Location command
NameTypeDescription
paramsArrayA list of command parameters. 0 = vehicle type, 1 = designation type, 2 = map id, 3 = x, 4 = y
Returns:
TypeDescription
booleanTrue if command succeeded

command203(params)boolean

Handling for the Set Event Location command
NameTypeDescription
paramsArrayA list of command parameters. 0 = character id, 1 = designation type, 2 = x (or other character id), 3 = y, 4 = direction
Returns:
TypeDescription
booleanTrue if command succeeded

command204(params)boolean

Handling for the Scroll Map command
NameTypeDescription
paramsArrayA list of command parameters. 0 = direction, 1 = distance, 2 = speed, 3 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command205(params)boolean

Handling for the Set Movement Route command
NameTypeDescription
paramsArrayA list of command parameters. 0 = character id, 1 = move route instruction object
Returns:
TypeDescription
booleanTrue if command succeeded

command206()boolean

Handling for the Get On/Off Vehicle command
Returns:
TypeDescription
booleanTrue if command succeeded

command211(params)boolean

Handling for the Change Transparency command
NameTypeDescription
paramsArrayA list of command parameters. 0 = on/off
Returns:
TypeDescription
booleanTrue if command succeeded

command212(params)boolean

Handling for the Show Animation command
NameTypeDescription
paramsArrayA list of command parameters. 0 = character id, 1 = animation id, 2 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command213(params)boolean

Handling for the Show Balloon Icon command
NameTypeDescription
paramsArrayA list of command parameters. 0 = character id, 1 = balloon id, 2 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command214()boolean

Handling for the Erase Event command
Returns:
TypeDescription
booleanTrue if command succeeded

command216(params)boolean

Handling for the Change Player Followers command
NameTypeDescription
paramsArrayA list of command parameters. 0 = show/hide
Returns:
TypeDescription
booleanTrue if command succeeded

command217()boolean

Handling for the Gather Followers command
Returns:
TypeDescription
booleanTrue if command succeeded

command221()boolean

Handling for the Fadeout Screen command
Returns:
TypeDescription
booleanTrue if command succeeded

command222()boolean

Handling for the Fadein Screen command
Returns:
TypeDescription
booleanTrue if command succeeded

command223(params)boolean

Handling for the Tint Screen command
NameTypeDescription
paramsArrayA list of command parameters. 0 = color array, 1 = duration, 2 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command224(params)boolean

Handling for the Flash Screen command
NameTypeDescription
paramsArrayA list of command parameters. 0 = color array, 1 = duration, 2 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command225(params)boolean

Handling for the Shake Screen command
NameTypeDescription
paramsArrayA list of command parameters. 0 = power, 1 = speed, 2 = duration, 3 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command230(params)boolean

Handling for the Wait command
NameTypeDescription
paramsArrayA list of command parameters. 0 = duration
Returns:
TypeDescription
booleanTrue if command succeeded

command231(params)boolean

Handling for the Show Picture command
NameTypeDescription
paramsArrayA list of command parameters. 0 = number, 1 = filename, 2 = origin, 3 = point designation, 4 = x, 5 = y, 6 = scale width, 7 = scale height, 8 = opacity, 9 = blend mode
Returns:
TypeDescription
booleanTrue if command succeeded

command232(params)boolean

Handling for the Move Picture command.
NameTypeDescription
paramsArrayA list of command parameters. 0 = number, 1 = unused, 2 = origin, 3 = point designation, 4 = x, 5 = y, 6 = scale width, 7 = scale height, 8 = opacity, 9 = blend mode, 10 = duration, 11 = wait, 12 = easing type
Returns:
TypeDescription
booleanTrue if command succeeded

command233(params)boolean

Handling for the Rotate Picture command
NameTypeDescription
paramsArrayA list of command parameters. 0 = picture id, 1 = speed
Returns:
TypeDescription
booleanTrue if command succeeded

command234(params)boolean

Handling for the Tint Picture command
NameTypeDescription
paramsArrayA list of command parameters. 0 = picture id, 1 = color array, 2 = duration, 3 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command235(params)boolean

Handling for the Erase Picture command
NameTypeDescription
paramsArrayA list of command parameters. 0 = picture id
Returns:
TypeDescription
booleanTrue if command succeeded

command236(params)boolean

Handling for the Set Weather Effect command
NameTypeDescription
paramsArrayA list of command parameters. 0 = type, 1 = power, 2 = duration, 3 = wait
Returns:
TypeDescription
booleanTrue if command succeeded

command241(params)boolean

Handling for the Play BGM command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe bgm filename
params[].volumenumberThe bgm volume
params[].pitchnumberThe bgm pitch
params[].pannumberThe bgm pan
Returns:
TypeDescription
booleanTrue if command succeeded

command242(params)boolean

Handling for the Fadeout BGM command
NameTypeDescription
paramsArrayA list of command parameters. 0 = duration
Returns:
TypeDescription
booleanTrue if command succeeded

command243()boolean

Handling for the Save BGM command
Returns:
TypeDescription
booleanTrue if command succeeded

command244()boolean

Handling for the Resume BGM command
Returns:
TypeDescription
booleanTrue if command succeeded

command245(params)boolean

Handling for the Play BGS command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe bgs filename
params[].volumenumberThe bgs volume
params[].pitchnumberThe bgs pitch
params[].pannumberThe bgs pan
Returns:
TypeDescription
booleanTrue if command succeeded

command246(params)boolean

Handling for the Fadeout BGS command
NameTypeDescription
paramsArrayA list of command parameters. 0 = duration
Returns:
TypeDescription
booleanTrue if command succeeded

command249(params)boolean

Handling for the Play ME command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe me filename
params[].volumenumberThe me volume
params[].pitchnumberThe me pitch
params[].pannumberThe me pan
Returns:
TypeDescription
booleanTrue if command succeeded

command250(params)boolean

Handling for the Play SE command
NameTypeDescription
paramsArray.<Object>A list of command parameters
params[].namestringThe se filename
params[].volumenumberThe se volume
params[].pitchnumberThe se pitch
params[].pannumberThe se pan
Returns:
TypeDescription
booleanTrue if command succeeded

command251()boolean

Handling for the Stop SE command
Returns:
TypeDescription
booleanTrue if command succeeded

command261(params)boolean

Handling for the Play Movie command
NameTypeDescription
paramsArrayA list of command parameters. 0 = filename
Returns:
TypeDescription
booleanTrue if command succeeded

command281(params)boolean

Handling for the Change Map Name Display command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enable/disable
Returns:
TypeDescription
booleanTrue if command succeeded

command282(params)boolean

Handling for the Change Tileset command
NameTypeDescription
paramsArrayA list of command parameters. 0 = tileset id
Returns:
TypeDescription
booleanTrue if command succeeded

command283(params)boolean

Handling for the Change Battle Background command
NameTypeDescription
paramsArrayA list of command parameters. 0 = image 1, 1 = image 2
Returns:
TypeDescription
booleanTrue if command succeeded

command284(params)boolean

Handling for the Change Parallax command
NameTypeDescription
paramsArrayA list of command parameters. 0 = filename, 1 = loop horizontal, 2 = loop vertical, 3 = scroll horizontal, 4 = scroll vertical
Returns:
TypeDescription
booleanTrue if command succeeded

command285(params)boolean

Handling for the Get Location Info command
NameTypeDescription
paramsArrayA list of command parameters. 0 = variable id, 1 = info type, 2 = designation type, 3 = x, 4 = y
Returns:
TypeDescription
booleanTrue if command succeeded

command301(params)boolean

Handling for the Battle Processing command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = troop id, 2 = can escape, 3 = can lose
Returns:
TypeDescription
booleanTrue if command succeeded

command302(params)boolean

Handling for the Shop Processing command
NameTypeDescription
paramsArrayA list of command parameters. 4 = purchase only
Returns:
TypeDescription
booleanTrue if command succeeded

command303(params)boolean

Handling for the Name Input Processing command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = max characters
Returns:
TypeDescription
booleanTrue if command succeeded

command311(params)boolean

Handling for the Change HP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = allow death
Returns:
TypeDescription
booleanTrue if command succeeded

command312(params)boolean

Handling for the Change MP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount
Returns:
TypeDescription
booleanTrue if command succeeded

command313(params)boolean

Handling for the Change State command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = add/remove, 3 = state id
Returns:
TypeDescription
booleanTrue if command succeeded

command314(params)boolean

Handling for the Recover All command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id
Returns:
TypeDescription
booleanTrue if command succeeded

command315(params)boolean

Handling for the Change EXP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = show level up
Returns:
TypeDescription
booleanTrue if command succeeded

command316(params)boolean

Handling for the Change Level command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = show level up
Returns:
TypeDescription
booleanTrue if command succeeded

command317(params)boolean

Handling for the Change Parameter command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = parameter, 3 = operation, 4 = operand, 5 = operand amount
Returns:
TypeDescription
booleanTrue if command succeeded

command318(params)boolean

Handling for the Change Skill command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = learn/forget, 3 = skill id
Returns:
TypeDescription
booleanTrue if command succeeded

command319(params)boolean

Handling for the Change Equipment command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = equip type id, 2 = equip item id
Returns:
TypeDescription
booleanTrue if command succeeded

command320(params)boolean

Handling for the Change Name command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = name
Returns:
TypeDescription
booleanTrue if command succeeded

command321(params)boolean

Handling for the Change Class command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = class id, 2 = save exp
Returns:
TypeDescription
booleanTrue if command succeeded

command322(params)boolean

Handling for the Change Actor Images command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = character image, 2 = character index, 3 = face image, 4 = face index, 5 = battler image
Returns:
TypeDescription
booleanTrue if command succeeded

command323(params)boolean

Handling for the Change Vehicle Image command
NameTypeDescription
paramsArrayA list of command parameters. 0 = vehicle type, 1 = image, 2 = image index
Returns:
TypeDescription
booleanTrue if command succeeded

command324(params)boolean

Handling for the Change Nickname command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = nickname
Returns:
TypeDescription
booleanTrue if command succeeded

command325(params)boolean

Handling for the Change Profile command
NameTypeDescription
paramsArrayA list of command parameters. 0 = actor id, 1 = profile
Returns:
TypeDescription
booleanTrue if command succeeded

command326(params)boolean

Handling for the Change TP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount
Returns:
TypeDescription
booleanTrue if command succeeded

command331(params)boolean

Handling for the Change Enemy HP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand, 4 = allow death
Returns:
TypeDescription
booleanTrue if command succeeded

command332(params)boolean

Handling for the Change Enemy MP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand
Returns:
TypeDescription
booleanTrue if command succeeded

command333(params)boolean

Handling for the Change Enemy State command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = add/remove, 2 = state id
Returns:
TypeDescription
booleanTrue if command succeeded

command334(params)boolean

Handling for the Enemy Recover All command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index
Returns:
TypeDescription
booleanTrue if command succeeded

command335(params)boolean

Handling for the Enemy Appear command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index
Returns:
TypeDescription
booleanTrue if command succeeded

command336(params)boolean

Handling for the Enemy Transform command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = enemy transform id
Returns:
TypeDescription
booleanTrue if command succeeded

command337(params)boolean

Handling for the Show Battle Animation command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = animation id
Returns:
TypeDescription
booleanTrue if command succeeded

command339(params)boolean

Handling for the Force Action command
NameTypeDescription
paramsArrayA list of command parameters. 0 = battler type, 1 = battler index/id, 2 = skill id, 3 = target index
Returns:
TypeDescription
booleanTrue if command succeeded

command340()boolean

Handling for the Abort Battle command
Returns:
TypeDescription
booleanTrue if command succeeded

command342(params)boolean

Handling for the Change Enemy TP command
NameTypeDescription
paramsArrayA list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand
Returns:
TypeDescription
booleanTrue if command succeeded

command351()boolean

Handling for the Open Menu Screen command
Returns:
TypeDescription
booleanTrue if command succeeded

command352()boolean

Handling for the Open Save Screen command
Returns:
TypeDescription
booleanTrue if command succeeded

command353()boolean

Handling for the Game Over command
Returns:
TypeDescription
booleanTrue if command succeeded

command354()boolean

Handling for the Return to Title Screen command
Returns:
TypeDescription
booleanTrue if command succeeded

command355()boolean

Handling for the Script command
Returns:
TypeDescription
booleanTrue if command succeeded

command356(params)booleanDeprecated

Handling for the Plugin Command (MV Style) command
NameTypeDescription
paramsArrayA list of command parameters. 0 = the plugin command string
Returns:
TypeDescription
booleanTrue if command succeeded

command357(params)boolean

Handling for the Plugin Command (MZ Style) command
NameTypeDescription
paramsArrayA list of command parameters. 0 = plugin filename, 1 = plugin command name, 2 = plugin command name, 3 = command parameters
Returns:
TypeDescription
booleanTrue if command succeeded

command402(params)boolean

Handling for the ** command
NameTypeDescription
paramsArrayA list of command parameters
Returns:
TypeDescription
booleanTrue if command succeeded

command403()boolean

Handling for the Cancel command
Returns:
TypeDescription
booleanTrue if command succeeded

command411()boolean

Handling for the Else command
Returns:
TypeDescription
booleanTrue if command succeeded

command413()boolean

Handling for the Repeat Above command
Returns:
TypeDescription
booleanTrue if command succeeded

command601()boolean

Handling for the If Win command
Returns:
TypeDescription
booleanTrue if command succeeded

command602()boolean

Handling for the If Escape command
Returns:
TypeDescription
booleanTrue if command succeeded

command603()boolean

Handling for the If Lose command
Returns:
TypeDescription
booleanTrue if command succeeded

currentCommand()Object

Get the current command
Returns:
TypeDescription
ObjectThe current command object

eventId()number

Get the interpreter event id
Returns:
TypeDescription
numberThe event id the interpreter belongs to

executeCommand()boolean

Executes the current command
Returns:
TypeDescription
booleanTrue if command executed

fadeSpeed()number

Get the interpreter fade speed
Returns:
TypeDescription
numberThe fade speed of the interpreter

gameDataOperand(type, param1, param2)number

Gets a value for a game data operand
NameTypeDescription
typenumberThe type of data to get
param1numberThe first parameter of the game data
param2numberThe second parameter of the game data
Returns:
TypeDescription
numberThe operand value

initialize(depth)

Initialize the interpreter
NameTypeDefaultDescription
depthnumber0optionalThe depth of the interpreter

isOnCurrentMap()boolean

Check if the interpreter is for the current map
Returns:
TypeDescription
booleanTrue if the interpreter is for the current map

isRunning()boolean

Check if the interpreter is running
Returns:
TypeDescription
booleanTrue if running

iterateActorEx(param1, param2, The)

Iterates the actor id by variable or direct designation
NameTypeDescription
param1number0 for direct, non-0 for variable
param2numberThe actor id or the variable id
Thefunctioncallback function

iterateActorId(param, The)

Iterates the actor id
NameTypeDescription
paramnumberThe actor id to iterate
Thefunctioncallback function

iterateActorIndex(param, The)

Iterates the actor id by party or individual actor
NameTypeDescription
paramnumber0 for entire party, non-0 for specific actor id
Thefunctioncallback function

iterateBattler(param1, param2, The)

Iterates the battler by enemy or actor
NameTypeDescription
param1number0 for enemy, non-0 for actor
param2numberThe actor id or the enemy index
Thefunctioncallback function

iterateEnemyIndex(param, The)

Iterates the enemy index by troop or individual enemy
NameTypeDescription
paramnumber0 for entire troop, non-0 for specific enemy id
Thefunctioncallback function
Jumps to a given index
NameTypeDescription
indexnumberThe index to jump to
Preload images used in the command list (face and picture images only)

nextEventCode()number

Get the next event code
Returns:
TypeDescription
numberThe code of the next command

operateValue(operation, operandType, operand)number

Gets an operation value
NameTypeDescription
operationnumberThe operation type to perform
operandTypenumberThe operand type of the operation to perform
operandnumberThe operand of the operation to perform
Returns:
TypeDescription
numberThe operate value

operateVariable(variableId, operationType, value)

Operates on a variable
NameTypeDescription
variableIdnumberThe variable id
operationTypenumberThe type of operation to perform
valuenumberThe value to use during the operation

picturePoint(params)Point

Get a picture point from command parameters
NameTypeDescription
paramsArrayA list of command parameters. 3 = designation type, 4 = x, 5 = y
Returns:
TypeDescription
PointThe point for picture x/y coordinates

pluginCommand()Deprecated

Handling for the MV Style Plugin Commands

setWaitMode(waitMode)

Set the wait mode of the interpreter
NameTypeDescription
waitModestringThe new wait mode of the interpreter

setup(list, eventId)

Set up the interpreter
NameTypeDefaultDescription
listArrayThe list of commands
eventIdnumber0optionalThe event id the interpreter belongs to

setupChild(list, eventId)

Sets up a child interpreter
NameTypeDescription
listArrayA list of commands
eventIdnumberThe event id for the child interpreter

setupChoices(params)

Sets up the choices for show choices event command
NameTypeDescription
paramsArrayA list of command parameters

setupItemChoice(params)

Performs setup for the item choice command
NameTypeDescription
paramsArrayA list of command parameters

setupNumInput(params)

Performs setup for the number input command
NameTypeDescription
paramsArrayA list of command parameters

setupReservedCommonEvent()boolean

Set up the interpreter for a reserved common event
Returns:
TypeDescription
booleanTrue if common event set up
Skip a branch
Terminate the interpreter
Update the interpreter

updateChild()boolean

Update child interpreter
Returns:
TypeDescription
booleanTrue if child interpreter is running

updateWait()boolean

Update interpreter wait
Returns:
TypeDescription
booleanTrue if wait updated

updateWaitCount()boolean

Update wait count
Returns:
TypeDescription
booleanTrue if wait count updated

updateWaitMode()boolean

Update interpreter wait mode
Returns:
TypeDescription
booleanTrue if waiting

videoFileExt()string

Get the video file extension
Returns:
TypeDescription
stringThe video file extension
Set the wait count of the interpreter
NameTypeDescription
durationnumberThe new wait count of the interpreter