RPG Paper Maker

Class: EventCommandStartBattle

EventCommandStartBattle

An event command for battle processing

new EventCommandStartBattle (command)

Name Type Description
command Object Direct JSON command to parse
Properties:
Name Type Description
battleMapID SystemValue The battle map (system) ID value
mapID SystemValue The map ID value
x SystemValue The x value
y SystemValue The y value
yPlus SystemValue The y plus value
z SystemValue The z value
canEscape boolean Boolean indicating if the player can escape this battle
canGameOver boolean Boolean indicating if there a win/lose node or not
troopID SystemValue The troop ID value
transitionStart number Transition start num bool
transitionStartColor SystemValue The transition start color ID value
transitionEnd number Transition end num bool
transitionEndColor SystemValue The transition end color ID value

Extends

Methods

initialize ()Object overrides

Initialize the current state
Returns:
Type Description
Object The current state

update (currentState, object, state)number overrides

Update and check if the event is finished
Name Type Description
currentState Object The current state of the event
object MapObject The current object reacting
state number The state ID
Returns:
Type Description
number The number of node to pass

onKeyPressed (currentState, key) inherited overrides

First key press handle for the current stack
Name Type Description
currentState Object The current state of the event
key number The key ID pressed

onKeyReleased (currentState, key) inherited overrides

First key release handle for the current stack
Name Type Description
currentState Object The current state of the event
key number The key ID pressed

onKeyPressedRepeat (currentState, key)boolean inherited overrides

Key pressed repeat handle for the current stack
Name Type Description
currentState Object The current state of the event
key number The key ID pressed
Returns:
Type Description
boolean

onKeyPressedAndRepeat (currentState, key) inherited overrides

Key pressed repeat handle for the current stack, but with a small wait after the first pressure (generally used for menus)
Name Type Description
currentState Object The current state of the event
key number The key ID pressed

drawHUD (currentState) inherited overrides

Draw the HUD
Name Type Description
currentState Object The current state of the event