EnemyBattler

Adds amount to a numeric flag named flag (or defines it if it does not exist)
This variant of Game:addFlag() interacts with flags specific to this enemy id

@param flag — The name of the flag to add to

@param amount — (Defaults to 1)

Adds (or removes) mercy from this enemy

Adds (or removes) temporary mercy from this enemy. Temporary mercy persists until kill_condition is true at any point.

@param play_sound — Whether to play a sound the first time temporary mercy is added

@param clamp — A table containing 2 number values that controls the range of the temporary mercy. Defaults to {0, 100}

@param kill_condition — A function that should return true when the temporary mercy should start to fade out.

(Override)

Checks the health of the enemy and defeats it if it is below zero.

@param on_defeat — A callback to run if the enemy is defeated

@param amount — The amount of damage taken by the last hit

@param battler — The party member that dealt the last hit

Called when an enemy is defeated by any means, controls recruit status, battle rewards, and removing the enemy from battle

@param reason — The mode the enemy was defeated by - default reasons are "SPARED", "PACIFIED" (Non-violent), "VIOLENCED", "FROZEN", "KILLED" (Violent), "DEFEATED" (Default)

@param violent — Whetehr the kill method is classed as violent and would result in the enemy's recruit becoming LOST.

Immediately defeats an enemy

@param amount — The amount of damage taken by the last hit

@param battler — The party member that dealt the last hit

Freezes this enemy and defeats them with the reason "FROZEN"
If this enemy can not be frozen, it makes them run away instead

Retrieves the data of an act on this enemy by its name

(Override) Gets the attack damage dealt to this enemy
By default, returns damage if it is a number greater than 0, otherwise using the attacking battler and points against this enemy's defense to calculate damage

@param points — The points of the hit, based on closeness to the target box when attacking, maximum value is 150

(Override) Gets the tension earned by hitting this enemy
By default, returns points / 25, or if you have reduced tension, points / 65

@param points — The points of the hit, based on closeness to the target box when attacking, maximum value is 150

(Override) Gets the text used by the Check act. By default, returns the name of the enemy in all caps and then the value defined in EnemyBattler.check

Gets the name of the damage sound used when this enemy is hit (defaults to "damage")

Gets the encounter text that should be shown in the battle box if this enemy is chosen for encounter text. Called at the start of each turn.

@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) Gets the dialogue the enemy should say each turn. *By default, picks a random dialogue from dialogue unless dialogue_override is set.

Gets the value of the flag named flag, returning default if the flag does not exist
This variant of Game:getFlag() interacts with flags specific to this enemy id

(Override) Get the default graze tension for this enemy. Any bullets which don't specify graze tension will use this value.

@return tension — The tension to gain when bullets spawned by this enemy are grazed.

(Override) Get what this enemy's HP should display in the enemy select menu. This should be a string.

By default, returns a percentage.

(Override) Get what this enemy's MERCY should display in the enemy select menu. This should be a string.

By default, returns a percentage.

(Override) Returns a nested table of colors {r, g, b} that the enemy's name will display in, with multiple colors forming a gradient, and one forming a solid color. *By default, returns a table with the spareable and tired colors, if the enemy meets their conditions

(Override) Gets the list of waves this enemy can use each turn. *By default, returns the waves table, unless wave_override is set.

Gets the text that should appear in the battle box when a battler attempts to spare this enemy

@param success — Whether the enemy was spared successfully

Gets the name of the X-Action usable on this enemy for each individual party member

@param battler — The battler the X-Action name is being retrieved for

Heals the enemy by amount health

@param amount — The amount of health to restore

@param sparkle_color — The color of the heal sparkles (defaults to the standard green) or false to not show sparkles

Deals damage to this enemy

@param amount — The amount of damage the enemy should take

@param battler — The party member dealing this damage

@param on_defeat — A callback to run if the enmy is defeated by this hit

@param color — The color of the damage, overriding the default damage color of the attacker

@param show_status — Whether to show the damage numbers from this hit

Whether the enemy is recruitable - automatically checks to see whether a recruit exists for this enemy

Whether the X-Action is a short act (Short acts all activate simultaneously) for each individual party member

@param battler — The battler the X-Action type is being retrieved for

Creates the particular flash effect used when a party member uses mercy on the enemy, but the spare fails

@param color — The color the enemy should flash (defaults to yellow)

(Override) Called when an ACT (including X-Acts, excluding short acts, see EnemyBattler:onShortAct()) is used on this enemy - This function should be overriden to define behaviour for every act
By default, manages the "Check" act - call super.onAct(self, battler, name) in any override to ensure Check is still handled
Acts will softlock Kristal if a string value or table is not returned by this function when they are used

(Override) Called when an ACT on this enemy starts
*By default, sets the sprties of all battlers involved in the act to "battle/act"

@param battler — The battler using this act - if it is a multi-act, this only specifies the one who used the command

@param name — The name of the act used

(Override) Called whenever the enemy is checked

(Override) Called when an enemy is defeated through violence
*By default, makes the enemy run via EnemyBattler:onDefeatRun() if exit_on_defeat is true

(Override) Normally unused, called to fatally defeat the enemy and defeat them with the reason "KILLED"

(Override) Called to defeat an enemy by making them flee when their hp is reduced to 0

(Override) Called when the enemy is attacked by a party member, but their hit misses

(Override) Called when an enemy is hurt
By default, starts the hit effects including shaking, hurt sprite, and checks whether the enemy can be made TIRED

@param battler — The battler that dealt the damage

(Override) Called when this enemy finishes hurting
*By default, stops the hurt shake and resets the enemy's sprite.

(Override) Called when a battler uses mercy on (spares) the enemy
By default, responsible for sparing the enemy or increasing their mercy points by spare_points

@return success — Whether the mercy resulted in a spare

(Override) Called when a short ACT is used, functions identically to EnemyBattler:onAct() but for short acts

(Override) Called when the enemy becomes spareable By default, sets the enemy's animation to "spared" (if it exists)

(Override) Called when the enemy is spared

(Override) Called at the end of every turn in battle

(Override) Called at the start of every new turn in battle

An override of Battler:recruitMessage()

Registers a new ACT for this enemy. This function is best called in EnemyBattler:init() for most acts, unless they only appear under specific conditions.
What happens when this act is used is controlled by EnemyBattler:onAct() - acts that do not return text there will softlock Kristal.

@param name — The name of the act

@param description — The short description of the act that appears in the menu

@param party — A list of party member ids required to use this act. Alternatively, the keyword "all" can be used to insert the entire current party

@param tp — An amount of TP required to use this act

@param highlight — A list of battlers that will be highlighted when the act is used, overriding default highlighting logic

@param icons — A list of texture paths to icons that will display next to the name of this act (party member heads are drawn automatically as required)

@return act — The data of the act, also added to the acts table

Registers a new ACT for this enemy that is usable by a specific character. This function is best called in EnemyBattler:init() for most acts, unless they only appear under specific conditions.
What happens when this act is used is controlled by EnemyBattler:onAct() - acts that do not return text there will softlock Kristal.

@param char — The id of the character that can use this act

@param name — The name of the act

@param description — The short description of the act that appears in the menu

@param party — A list of party member ids required to use this act. Alternatively, the keyword "all" can be used to insert the entire current party

@param tp — An amount of TP required to use this act

@param highlight — A list of battlers that will be highlighted when the act is used, overriding default highlighting logic

@param icons — A list of texture paths to icons that will display next to the name of this act (party member heads are drawn automatically as required)

Registers a new Short ACT for this enemy. This function is best called in EnemyBattler:init() for most acts, unless they only appear under specific conditions.
What happens when this act is used is controlled by EnemyBattler:onShortAct() - acts that do not return text there will softlock Kristal.

@param name — The name of the act

@param description — The short description of the act that appears in the menu

@param party — A list of party member ids required to use this act. Alternatively, the keyword "all" can be used to insert the entire current party

@param tp — An amount of TP required to use this act

@param highlight — A list of battlers that will be highlighted when the act is used, overriding default highlighting logic

@param icons — A list of texture paths to icons that will display next to the name of this act (party member heads are drawn automatically as required)

@return act — The data of the act, also added to the acts table

Registers a new Short ACT for this enemy, usable by a specific character. This function is best called in EnemyBattler:init() for most acts, unless they only appear under specific conditions.
What happens when this act is used is controlled by EnemyBattler:onShortAct() - acts that do not return text there will softlock Kristal.

@param char — The id of the character that can use this act

@param name — The name of the act

@param description — The short description of the act that appears in the menu

@param party — A list of party member ids required to use this act. Alternatively, the keyword "all" can be used to insert the entire current party

@param tp — An amount of TP required to use this act

@param highlight — A list of battlers that will be highlighted when the act is used, overriding default highlighting logic

@param icons — A list of texture paths to icons that will display next to the name of this act (party member heads are drawn automatically as required)

(Override) Selects the wave that this enemy will use each turn. By default, picks from the available selection provided by EnemyBattler:getNextWaves()

Sets the actor used for this enemy.

@param actor — The id or instance of the Actor to set on this battler.

@param use_overlay — Whether to use the overlay sprite system (Defaults to true)

Sets the value of the flag named flag to value
This variant of Game:setFlag() interacts with flags specific to this enemy id

Shorthand for ActorSprite:setSprite() and ActorSprite:play()

@param bool — New tired state

@param hide_message — Hides the "TIRED" or "AWAKE" message (if it would otherwise have been shown) if set to true.

Non-violently defeats the enemy and removes them from battle (if exit_on_defeat is true)

@param pacify — Whether the enemy was defeated by pacifying them rather than sparing them (defaults to false)

An override of Battler:statusMessage() that positions the message for this EnemyBattler

(Used internally) Stores the data of all ACTs available on this enemy

The attack stat of this enemy

Whether this enemy can be frozen

The flavour text displayed when this enemy is checked. Stat text is added automatically.

The text displayed next to this enemy's name in menu's (such as "(Tired)" in DELTARUNE)

Whether this enemy has been defeated

The defense stat of this enemy

A list of dialogue choices this enemy will select one from at the start of every attacking turn

The offset of this enemy's dialogue bubble

An instance of dialogue that will be used on the enemy this turn instead of a randomly selected dialogue. Reset every turn.

Whether this enemy has mercy disabled (such as with snowgrave Spamton NEO). Only affects the mercy bar.

The offset of this enemy's damage sprites

A list of this enemy's damage sprites

Encounters detail the setup of unique battles in Kristal, from the enemies that appear to the environment and special mechanics.
Encounter files should be placed inside scripts/battle/encounters/.

The experience gained when this enemy is defeated

The current health of this enemy

How long this enemy's hurt sprite should be displayed for when hit

A number from 0-1 that defines what percentage of maximum hp the low_health_text of this enemy starts displaying

A special text that displays when this enemy is at low HP. See low_health_percentage for defining the low HP threshold.

The maximum health of this enemy

The amount of mercy points this enemy has

The money added to the battle prize money when this enemy is defeated

Whether this enemy is selectable in menus

The amount of mercy that is added to this enemy when a character spares them below max mercy

A special text that displays when this enemy is spareable.

The current amount of temporary mercy

The DamageNumber object, used to update the mercy display

A list of encounter flavour texts that can be selected from at random to display in the battle box at the start of each turn

Whether this enemy is tired

A number from 0-1 that defines what percentage of maximum hp this enemy should become tired at

A special text that displays when this enemy is TIRED.

A wave id that will be used by the enemy this turn rather than a randomly selected wave. Reset every turn.

A list of wave ids this enemy can use - one is selected each turn in EnemyBattler:selectWave()

(1/10 of a defend, or cheap spell)