Battle

Advances all enemy dialogue bubbles

Returns the equipment-modified heal amount from a healing action performed by the specified party member

@param base_heal — The heal amount to modify

@param healer — The character performing the heal action

Sets the current message in the battlebox and moves to the BATTLETEXT state until it is advanced, where it returns to the previous state by default

@param text — The text to set

@param post_func — When the text is advanced, the name of the state to move to, or a function to run

Checks to see whether the whole party is downed and starts a GameOver if they are

Returns whether collider collides with the arena

Gets a list of all the active (not defeated/spared) enemies

Gets a list of all the active (not downed) party members

Returns the tension gained from defending. By default, this redirects to Encounter.

@param battler — The current battler about to defend.

@return tension — The tension gained from defending.

Gets an EnemyBattler in the current battle from their id

Gets an enemy in battle from their corresponding world Character

Gets a PartyBattler in the current battle from their id

Gets the index of a party member with the given id

Gets the location the soul should spawn at when waves start by default

Gets whether a specific character has an action lined up

Checks if the current encounter has reduced tension. By default, this redirects to Encounter

@return reduced — Whether the encounter has reduced tension.

Hurts the target party member(s)

@param target — The target battler's index, instance, or strings for specific selection logic (defaults to "ANY")

--  `PartyBattler`s are a type of `Battler` that represent [`PartyMember`](file:///vercel/path0/tmp/kristal/src/engine/game/common/data/partymember.lua#73)s when they are in battle. \
--  The set of `PartyBattler`s in the current battle are stored in [`Game.battle.party`](file:///vercel/path0/tmp/kristal/src/engine/game/battle.lua#6). \
--  Unlike `EnemyBattler`, party members do not need to define a `PartyBattler` in a file as their PartyMember file defines everything necessary and is utilised by `PartyBattler`.
-- 
target:
    | "ALL"
    | "ANY"

Sets the current message in the battlebox - this text can not be advanced, only overwritten if another text is set

@param text — The text to set

Advances to the next turn of the battle

Turns a party member's turn from an ACT into a SPELL cast
Should be called from inside EnemyBattler:onAct()

@param spell — The name of the spell that should be casted by user

@param battler — The id of the battler that initiates the ACT

@param user — The id of the battler that should cast the spell

@param target — An optional list of battlers that

--  `PartyBattler`s are a type of `Battler` that represent [`PartyMember`](file:///vercel/path0/tmp/kristal/src/engine/game/common/data/partymember.lua#73)s when they are in battle. \
--  The set of `PartyBattler`s in the current battle are stored in [`Game.battle.party`](file:///vercel/path0/tmp/kristal/src/engine/game/battle.lua#6). \
--  Unlike `EnemyBattler`, party members do not need to define a `PartyBattler` in a file as their PartyMember file defines everything necessary and is utilised by `PartyBattler`.
-- 
return #1:
    | "ANY"

--  `PartyBattler`s are a type of `Battler` that represent [`PartyMember`](file:///vercel/path0/tmp/kristal/src/engine/game/common/data/partymember.lua#73)s when they are in battle. \
--  The set of `PartyBattler`s in the current battle are stored in [`Game.battle.party`](file:///vercel/path0/tmp/kristal/src/engine/game/battle.lua#6). \
--  Unlike `EnemyBattler`, party members do not need to define a `PartyBattler` in a file as their PartyMember file defines everything necessary and is utilised by `PartyBattler`.
-- 
return #1:
    | "ALL"

Registers an additional X-Action for a specific party member

@param party — The id of the party member who will receive this X-Action

@param name — The name of this X-Action

@param description — The description of this X-Action

@param tp — The tp cost of this X-Action

Removes an enemy from the battle

@param enemy — The EnemyBattler that should be removed

@param defeated — If true, the enemy is considered as 'defeated'

Resets the enemies index table, closing all gaps in the enemy select menu

@param reset_xact — Whether to also reset the XACT position

Ends the battle and removes itself from Game.battle

Changes the state of the battle and calls onStateChange()

Changes the substate of the battle and calls onSubStateChange()

Sets the waves table to what is specified by waves

@param allow_duplicates — If true, duplicate waves will coexist with each other

Shakes the camera by the specified x, y.

@param x — The amount of shake in the x direction. (Defaults to 4)

@param y — The amount of shake in the y direction. (Defaults to 4)

@param friction — The amount that the shake should decrease by, per frame at 30FPS. (Defaults to 1)

Spawns the soul and sets up its transition from the source character to its starting position

Starts a cutscene in battle where the cutscene receives the the currently ACTing character and the ACT's target as additional arguments \

@param group — The name of the group the cutscene is a part of

@param id — The id of the cutscene

@param dont_finish — Whether the action should end when the cutscene finishes (defaults to false)

Starts a cutscene in battle
When setting a cutscene during the ACTIONS state, see `Battle:startActCutscene() instead

@param group — The name of the group the cutscene is a part of

@param id — The id of the cutscene

@param ... — Additional arguments that will be passed to the cutscene function

Replaces the current soul (if it exists) with a different soul instance

--  `PartyBattler`s are a type of `Battler` that represent [`PartyMember`](file:///vercel/path0/tmp/kristal/src/engine/game/common/data/partymember.lua#73)s when they are in battle. \
--  The set of `PartyBattler`s in the current battle are stored in [`Game.battle.party`](file:///vercel/path0/tmp/kristal/src/engine/game/battle.lua#6). \
--  Unlike `EnemyBattler`, party members do not need to define a `PartyBattler` in a file as their PartyMember file defines everything necessary and is utilised by `PartyBattler`.
-- 
return #1:
    | "ALL"
    | "ANY"

return #1:
    | "ALL"

return #1:
    | "ANY"

Target positions for PartyBattlers to transition to at the start of battle

The active battle cutscene, if it exists - see Battle:startCutscene() or Battle:startActCutscene() for how to start cutscenes

The encounter currently being used for this battle (only set during postInit())

An optional ChaserEnemy instance that initiated the battle

The position of each EnemyBattler at the start of the battle transition

A list of mappings between EnemyBattlers and their representations as Characters in the world, if they exist

Objects parented to this will be masked to the arena

Current amount of victory money

A table of all the PartyBattlers in the current battle

The position of each PartyBattler at the start of the battle transition

A list of mappings between PartyBattlers (by id) and their representations as Characters in the world, if they exist

(only set during postInit())

The Soul is the object the player controls in battle.
The Soul global stores the default (red) soul. Custom soul types can be created by extending this class in a new global (using a file in scripts/objects/ or scripts/globals/). The soul being used in battle is determined by Encounter:createSoul, and can be altered after the first DEFENDING stage with Battle:swapSoul().

A sound source for the spare sfx, should be used for every time this sound plays in battle

The current state of the battle - should never be set manually, see Battle:setState() instead

The reason for the current state of the battle - should never be set manually, see Battle:setState() instead

The current substate of the battle - should never be set manually, see Battle:setSubState() instead

Whether the battle opened with a transition (only set during postInit())

The current turn number

A sound source for the ui_move sfx, should be used for every time this sound plays in battle

A sound source for the ui_select sfx, should be used for every time this sound plays in battle

Current amount of victory xp

TODO: pagination

Keep decrementing until there's a selectable enemy.

No wrapping in this menu.

No wrapping in this menu.

Keep decrementing until there's a selectable enemy.

Keep decrementing until there's a selectable enemy.