changeHp(target, value, allowDeath)
Change hp of a target
Name | Type | Description |
---|
target | Game_Battler | The target |
value | number | The value to change the hp by |
allowDeath | boolean | Allow the target to die by this operation? |
Get the character by param
Name | Type | Description |
---|
param | number | negative for player, 0 for the event id |
Returns:
Check for freeze
Returns:
Type | Description |
---|
boolean | True if frozen |
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
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = filename, 1 = file index, 2 = background type, 3 = position type, 4 = name |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command102(params)boolean
Handling for the Show Choices command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = choice array, 1 = cancel, 2 = default, 3 = position type, 4 = background type |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command103(params)boolean
Handling for the Input Number command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = variable id, 1 = number of digits |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command104(params)boolean
Handling for the Select Item command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = variable id, 1 = item type |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command105(params)boolean
Handling for the Scrolling Text command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = speed, 1 = no fast forward setting |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command108(params)boolean
Handling for the Comment command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = The comment text (first line), subsequent lines stored in command 408 |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Skip command
- Since:
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command111(params)boolean
Handling for the Conditional Branch command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = condition type, other values vary by type. |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Loop command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Break Loop command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Exit Event Processing command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command117(params)boolean
Handling for the Common Event command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = common event id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Label command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command119(params)boolean
Handling for the Jump to Label command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = label name |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command121(params)boolean
Handling for the Control Switches command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = first switch id in range, 1 = last switch id in range, 2 = enable/disable value |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command122(params)boolean
Handling for the Control Variables command
Name | Type | Description |
---|
params | Array | A 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:
Type | Description |
---|
boolean | True if command succeeded |
command123(params)boolean
Handling for the Control Self Switch command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = switch id, 1 = enable/disable value |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command124(params)boolean
Handling for the Control Timer command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = start or stop, 1 = time (if start) |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command125(params)boolean
Handling for the Change Gold command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = operation, 1 = operand type, 2 = operand value |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command126(params)boolean
Handling for the Change Items command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = item id, 1 = operation, 2 = operand type, 3 = operand value |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command127(params)boolean
Handling for the Change Weapons command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = weapon id, 1 = operation, 2 = operand type, 3 = operand value, 4 = include equip |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command128(params)boolean
Handling for the Change Armors command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = armor id, 1 = operation, 2 = operand type, 3 = operand value, 4 = include equip |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command129(params)boolean
Handling for the Change Party Member command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = operation, 2 = initialize flag |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command132(params)boolean
Handling for the Change Battle BGM command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The bgm filename |
params[].volume | number | The bgm volume |
params[].pitch | number | The bgm pitch |
params[].pan | number | The bgm pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command133(params)boolean
Handling for the Change Victory ME command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The me filename |
params[].volume | number | The me volume |
params[].pitch | number | The me pitch |
params[].pan | number | The me pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command134(params)boolean
Handling for the Change Save Access command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enable/disable |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command135(params)boolean
Handling for the Change Menu Access command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enable/disable |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command136(params)boolean
Handling for the Change Encounter command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enable/disable |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command137(params)boolean
Handling for the Change Formation Access command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enable/disable |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command138(params)boolean
Handling for the Change Window Color command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = Red, 1 = Green, 2 = Blue |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command139(params)boolean
Handling for the Change Defeat ME command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The me filename |
params[].volume | number | The me volume |
params[].pitch | number | The me pitch |
params[].pan | number | The me pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command140(params)boolean
Handling for the Change Vehicle BGM command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = vehicle type, 1 = bgm properties |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command201(params)boolean
Handling for the Transfer Player command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = map id, 2 = x, 3 = y, 4 = direction, 5 = fade type |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command202(params)boolean
Handling for the Set Vehicle Location command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = vehicle type, 1 = designation type, 2 = map id, 3 = x, 4 = y |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command203(params)boolean
Handling for the Set Event Location command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = character id, 1 = designation type, 2 = x (or other character id), 3 = y, 4 = direction |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command204(params)boolean
Handling for the Scroll Map command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = direction, 1 = distance, 2 = speed, 3 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command205(params)boolean
Handling for the Set Movement Route command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = character id, 1 = move route instruction object |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Get On/Off Vehicle command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command211(params)boolean
Handling for the Change Transparency command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = on/off |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command212(params)boolean
Handling for the Show Animation command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = character id, 1 = animation id, 2 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command213(params)boolean
Handling for the Show Balloon Icon command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = character id, 1 = balloon id, 2 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Erase Event command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command216(params)boolean
Handling for the Change Player Followers command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = show/hide |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Gather Followers command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Fadeout Screen command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Fadein Screen command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command223(params)boolean
Handling for the Tint Screen command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = color array, 1 = duration, 2 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command224(params)boolean
Handling for the Flash Screen command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = color array, 1 = duration, 2 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command225(params)boolean
Handling for the Shake Screen command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = power, 1 = speed, 2 = duration, 3 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command230(params)boolean
Handling for the Wait command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = duration |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command231(params)boolean
Handling for the Show Picture command
Name | Type | Description |
---|
params | Array | A 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:
Type | Description |
---|
boolean | True if command succeeded |
command232(params)boolean
Handling for the Move Picture command.
Name | Type | Description |
---|
params | Array | A 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:
Type | Description |
---|
boolean | True if command succeeded |
command233(params)boolean
Handling for the Rotate Picture command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = picture id, 1 = speed |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command234(params)boolean
Handling for the Tint Picture command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = picture id, 1 = color array, 2 = duration, 3 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command235(params)boolean
Handling for the Erase Picture command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = picture id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command236(params)boolean
Handling for the Set Weather Effect command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = type, 1 = power, 2 = duration, 3 = wait |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command241(params)boolean
Handling for the Play BGM command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The bgm filename |
params[].volume | number | The bgm volume |
params[].pitch | number | The bgm pitch |
params[].pan | number | The bgm pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command242(params)boolean
Handling for the Fadeout BGM command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = duration |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Save BGM command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Resume BGM command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command245(params)boolean
Handling for the Play BGS command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The bgs filename |
params[].volume | number | The bgs volume |
params[].pitch | number | The bgs pitch |
params[].pan | number | The bgs pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command246(params)boolean
Handling for the Fadeout BGS command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = duration |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command249(params)boolean
Handling for the Play ME command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The me filename |
params[].volume | number | The me volume |
params[].pitch | number | The me pitch |
params[].pan | number | The me pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command250(params)boolean
Handling for the Play SE command
Name | Type | Description |
---|
params | Array.<Object> | A list of command parameters |
params[].name | string | The se filename |
params[].volume | number | The se volume |
params[].pitch | number | The se pitch |
params[].pan | number | The se pan |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Stop SE command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command261(params)boolean
Handling for the Play Movie command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = filename |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command281(params)boolean
Handling for the Change Map Name Display command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enable/disable |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command282(params)boolean
Handling for the Change Tileset command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = tileset id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command283(params)boolean
Handling for the Change Battle Background command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = image 1, 1 = image 2 |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command284(params)boolean
Handling for the Change Parallax command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = filename, 1 = loop horizontal, 2 = loop vertical, 3 = scroll horizontal, 4 = scroll vertical |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command285(params)boolean
Handling for the Get Location Info command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = variable id, 1 = info type, 2 = designation type, 3 = x, 4 = y |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command301(params)boolean
Handling for the Battle Processing command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = troop id, 2 = can escape, 3 = can lose |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command302(params)boolean
Handling for the Shop Processing command
Name | Type | Description |
---|
params | Array | A list of command parameters. 4 = purchase only |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command303(params)boolean
Handling for the Name Input Processing command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = max characters |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command311(params)boolean
Handling for the Change HP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = allow death |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command312(params)boolean
Handling for the Change MP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command313(params)boolean
Handling for the Change State command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = add/remove, 3 = state id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command314(params)boolean
Handling for the Recover All command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command315(params)boolean
Handling for the Change EXP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = show level up |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command316(params)boolean
Handling for the Change Level command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount, 5 = show level up |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command317(params)boolean
Handling for the Change Parameter command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = parameter, 3 = operation, 4 = operand, 5 = operand amount |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command318(params)boolean
Handling for the Change Skill command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = learn/forget, 3 = skill id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command319(params)boolean
Handling for the Change Equipment command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = equip type id, 2 = equip item id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command320(params)boolean
Handling for the Change Name command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = name |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command321(params)boolean
Handling for the Change Class command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = class id, 2 = save exp |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command322(params)boolean
Handling for the Change Actor Images command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = character image, 2 = character index, 3 = face image, 4 = face index, 5 = battler image |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command323(params)boolean
Handling for the Change Vehicle Image command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = vehicle type, 1 = image, 2 = image index |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command324(params)boolean
Handling for the Change Nickname command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = nickname |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command325(params)boolean
Handling for the Change Profile command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = actor id, 1 = profile |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command326(params)boolean
Handling for the Change TP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = designation type, 1 = actor id, 2 = operation, 3 = operand, 4 = operand amount |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command331(params)boolean
Handling for the Change Enemy HP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand, 4 = allow death |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command332(params)boolean
Handling for the Change Enemy MP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command333(params)boolean
Handling for the Change Enemy State command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = add/remove, 2 = state id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command334(params)boolean
Handling for the Enemy Recover All command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command335(params)boolean
Handling for the Enemy Appear command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command336(params)boolean
Handling for the Enemy Transform command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = enemy transform id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command337(params)boolean
Handling for the Show Battle Animation command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = animation id |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command339(params)boolean
Handling for the Force Action command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = battler type, 1 = battler index/id, 2 = skill id, 3 = target index |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Abort Battle command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command342(params)boolean
Handling for the Change Enemy TP command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = enemy index, 1 = parameter, 2 = operation, 3 = operand |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Open Menu Screen command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Open Save Screen command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Game Over command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Return to Title Screen command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Script command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command356(params)booleanDeprecated
Handling for the Plugin Command (MV Style) command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = the plugin command string |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command357(params)boolean
Handling for the Plugin Command (MZ Style) command
Name | Type | Description |
---|
params | Array | A list of command parameters. 0 = plugin filename, 1 = plugin command name, 2 = plugin command name, 3 = command parameters |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
command402(params)boolean
Handling for the ** command
Name | Type | Description |
---|
params | Array | A list of command parameters |
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Cancel command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Else command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the Repeat Above command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the If Win command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the If Escape command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Handling for the If Lose command
Returns:
Type | Description |
---|
boolean | True if command succeeded |
Get the current command
Returns:
Type | Description |
---|
Object | The current command object |
Get the interpreter event id
Returns:
Type | Description |
---|
number | The event id the interpreter belongs to |
Executes the current command
Returns:
Type | Description |
---|
boolean | True if command executed |
Get the interpreter fade speed
Returns:
Type | Description |
---|
number | The fade speed of the interpreter |
gameDataOperand(type, param1, param2)number
Gets a value for a game data operand
Name | Type | Description |
---|
type | number | The type of data to get |
param1 | number | The first parameter of the game data |
param2 | number | The second parameter of the game data |
Returns:
Type | Description |
---|
number | The operand value |
Initialize the interpreter
Name | Type | Default | Description |
---|
depth | number | 0 | optionalThe depth of the interpreter |
Check if the interpreter is for the current map
Returns:
Type | Description |
---|
boolean | True if the interpreter is for the current map |
Check if the interpreter is running
Returns:
Type | Description |
---|
boolean | True if running |
iterateActorEx(param1, param2, The)
Iterates the actor id by variable or direct designation
Name | Type | Description |
---|
param1 | number | 0 for direct, non-0 for variable |
param2 | number | The actor id or the variable id |
The | function | callback function |
iterateActorId(param, The)
Iterates the actor id
Name | Type | Description |
---|
param | number | The actor id to iterate |
The | function | callback function |
iterateActorIndex(param, The)
Iterates the actor id by party or individual actor
Name | Type | Description |
---|
param | number | 0 for entire party, non-0 for specific actor id |
The | function | callback function |
iterateBattler(param1, param2, The)
Iterates the battler by enemy or actor
Name | Type | Description |
---|
param1 | number | 0 for enemy, non-0 for actor |
param2 | number | The actor id or the enemy index |
The | function | callback function |
iterateEnemyIndex(param, The)
Iterates the enemy index by troop or individual enemy
Name | Type | Description |
---|
param | number | 0 for entire troop, non-0 for specific enemy id |
The | function | callback function |
Jumps to a given index
Name | Type | Description |
---|
index | number | The index to jump to |
Preload images used in the command list (face and picture images only)
Get the next event code
Returns:
Type | Description |
---|
number | The code of the next command |
operateValue(operation, operandType, operand)number
Gets an operation value
Name | Type | Description |
---|
operation | number | The operation type to perform |
operandType | number | The operand type of the operation to perform |
operand | number | The operand of the operation to perform |
Returns:
Type | Description |
---|
number | The operate value |
operateVariable(variableId, operationType, value)
Operates on a variable
Name | Type | Description |
---|
variableId | number | The variable id |
operationType | number | The type of operation to perform |
value | number | The value to use during the operation |
picturePoint(params)Point
Get a picture point from command parameters
Name | Type | Description |
---|
params | Array | A list of command parameters. 3 = designation type, 4 = x, 5 = y |
Returns:
Type | Description |
---|
Point | The point for picture x/y coordinates |
pluginCommand()Deprecated
Handling for the MV Style Plugin Commands
Set the wait mode of the interpreter
Name | Type | Description |
---|
waitMode | string | The new wait mode of the interpreter |
Set up the interpreter
Name | Type | Default | Description |
---|
list | Array | | The list of commands |
eventId | number | 0 | optionalThe event id the interpreter belongs to |
setupChild(list, eventId)
Sets up a child interpreter
Name | Type | Description |
---|
list | Array | A list of commands |
eventId | number | The event id for the child interpreter |
Sets up the choices for show choices event command
Name | Type | Description |
---|
params | Array | A list of command parameters |
Performs setup for the item choice command
Name | Type | Description |
---|
params | Array | A list of command parameters |
Performs setup for the number input command
Name | Type | Description |
---|
params | Array | A list of command parameters |
setupReservedCommonEvent()boolean
Set up the interpreter for a reserved common event
Returns:
Type | Description |
---|
boolean | True if common event set up |
Skip a branch
Terminate the interpreter
Update the interpreter
Update child interpreter
Returns:
Type | Description |
---|
boolean | True if child interpreter is running |
Update interpreter wait
Returns:
Type | Description |
---|
boolean | True if wait updated |
Update wait count
Returns:
Type | Description |
---|
boolean | True if wait count updated |
Update interpreter wait mode
Returns:
Type | Description |
---|
boolean | True if waiting |
Get the video file extension
Returns:
Type | Description |
---|
string | The video file extension |
Set the wait count of the interpreter
Name | Type | Description |
---|
duration | number | The new wait count of the interpreter |