Encounter

Adds an enemy to the encounter.

@param enemy — The id of an EnemyBattler, or an EnemyBattler instance.

@param ... — Additional arguments to pass to EnemyBattler:init().

Increments a numerical flag by amount.

@param amount — (Defaults to 1)

(Override) Called when Battle:setState() is called.
Changing the state to something other than new, or returning true will stop the standard state change code for this state change from occurring.

(Override) Whether a party member can get swooned in this encounter or not. By default, returns true for everyone.

@param target — The current target.

(Override) Creates the soul being used this battle (Called at the start of the first wave) By default, returns the regular (red) soul.

@param x — The x-coordinate the soul should spawn at.

@param y — The y-coordinate the soul should spawn at.

@param color — A custom color for the soul, that should override its default.

(Override) Called before anything has been rendered each frame. Usable to draw custom backgrounds for specific encounters.

@param fade — The opacity of the background when fading in/out of the world.

(Override) Called after everything has been rendered each frame. Usable to draw custom effects for specific encounters.

@param fade — The opacity of the background when fading in/out of the world.

@return defeated_enemies — A table indicating the enemies defeated in battle.

Returns the tension gained from defending. Returns 2% if reduced tension, otherwise 16%.

@param battler — The current battler about to defend.

@return tension — The tension gained from defending.

(Override) Called whenever dialogue is about to start, if this returns a value, it will be unpacked and passed into Battle:startCutscene(...), as an alternative to standard dialogue.

(Override) Called to receive the encounter text to be displayed each turn. (Not called on turn one, getInitialEncounterText is used instead.)
By default, gets an encounter text from a random enemy, falling back on the encounter's encounter text if none have encounter text.

@return text — If a table, you should use [next] to advance the text

@return portrait — The portrait to show

@return actor — The actor to use for the text settings (ex. voice, portrait settings)

(Override) Called to receive the initial encounter text to be displayed on the first turn. (Not called on any other turns unless getEncounterText can't find any usable text.)
By default, returns the encounter text.

@return text — If a table, you should use [next] to advance the text

@return portrait — The portrait to show

@return actor — The actor to use for the text settings (ex. voice, portrait settings)

(Override) Retrieves the waves to be used for the next defending phase.
By default, iterates through all active enemies and selects one wave each using EnemyBattler:selectWave()

(Override) Gets the position the party member at index should stand at in this battle.

@param index — The index of the party member in Game.battle.party.

(Override) Gets the position that the soul will appear at when starting waves.

@param money — Current victory money based on normal money calculations

@param text — Current victory text

@param money — Money earned on victory

@param xp — XP earned on victory

@param xp — Current victory xp based on normal xp calculations

Checks if the encounter has reduced tension.

@return reduced — Whether the encounter has reduced tension.

(Override) Whether automatic healing while downed is enabled in this encounter.
By default, returns true.

@param battler — The current battler about to auto-heal.

(Override) Called when an ActionButton is selected.

(Override) Called when the party finish performing their actions.

(Override) Called when the party start performing their actions.

(Override) Called when the battle is completed and the victory text (if presesnt) is advanced, just before the transition out.

(Override) Called in Battle:postInit().
If this function returns true, then the battle will not override any state changes made here.

(Override) Called when the battle enters the "INTRO" state and the characters do their starting animations.

(Override) Called when a character's turn selecting actions begins.

@param battler — The battler whose turn it is.

@param undo — Whether this character's turn was entered by undoing their previously selected action.

(Override) Called when enemy dialogue is finished and closed, before the transition into a wave.

(Override) Called when the player backs out of an enemyselect menu in battle.

@param state_reason — The current value of Battle.state_reason

@param enemy_index — The index of the selected enemy on the menu.

(Override) Called when the player selects an enemy in battle.

@param state_reason — The current value of Battle.state_reason

@param enemy_index — The index of the selected enemy on the menu.

(Override) Called just before a Game Over.
If this function returns true, then the Game Over will not occur

(Override) Called when the player backs out of a menu.

@param state_reason — The current value of Battle.state_reason

@param item — A table of information representing the menu item that was being hovered over.

(Override) Called when an item in a menu is selected (confirm key pressed).

@param state_reason — The current value of Battle.state_reason

@param item — A table of information representing the menu item.

@param can_select — Whether the item is actually selectable or is greyed out.

(Override) Called when the player backs out of a partyselect menu in battle.

@param state_reason — The current value of Battle.state_reason

@param party_index — The index of the selected enemy on the menu.

(Override) Called when the player selects a party member in a partyselect menu in battle.

@param state_reason — The current value of Battle.state_reason

@param party_index — The index of the selected enemy on the menu.

(Override) Called just before returning to the world.

@param events — A list of enemy events in the world that are linked to the enemies in battle.

(Override) Called when Battle:setState() is called, after any state change code has run.

(Override) Called at the end of each turn, at the same time all waves end.

(Override) Called at the start of each new turn, just before the player starts choosing actions.

(Override) Called when all the waves of the current turn have finished.