Battler

Creates an alert bubble (tiny !) above this battler.

@param duration — The number of frames to show the bubble for. (Defaults to 20)

@param options — A table defining additional properties to control the bubble.

options:
    | "play_sound" -- Whether the alert sound will be played. (Defaults to `true`)
    | "sprite" -- The sprite to use for the alert bubble. (Defaults to `"effects/alert"`)
    | "offset_x" -- The x-offset of the icon.
    | "offset_y" -- The y-offset of the icon.
    | "layer" -- The layer to put the icon on. (Defaults to `100`)
    | "callback" -- A callback that is run when the alert finishes.

Makes the battler flash once.

@param sprite — An optional sprite to use for the flash instead of the battler's default sprite.

Returns the active sprite, out of the battler's main and overlay sprite.

Creates a standard "healing effect" (flash, sparkles).

(Override) Called whenever a speech bubble is removed for this battler.

(Override) Called whenever a speech bubble is created for this battler.

(Called internally) Creates a RECRUIT message for when an enemy is spared and recruit progression advances

Sets the actor used for this battler.

@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)

Shorthand for ActorSprite:setAnimation()

Shorthand for calling ActorSprite:setCustomSprite() and then ActorSprite:play()

Creates sparkles around the battler (these appear by default when the battler receives healing)

Creates a speech bubble for this battler.

@param text — The text to display in the speech bubble. Can be a table defining multiple lines.

@param options — A table defining additional properties to control the speech bubble:

options:
    | "style" -- The dialogue bubble style to use (Defaults to [`Battler.dialogue_bubble`](file:///vercel/path0/tmp/kristal/src/engine/game/battle/battler.lua#19))
    | "right" -- Whether the dialogue bubble should appear to the right of the battler (Defaults to `false`)
    | "font" -- The font to use for the speech bubble
    | "actor" -- The actor to use for the speech bubble
    | "after" -- A callback that will be run after the dialogue is finished
    | "line_callback" -- A callback that will be run after each line of dialogue is advanced

Creates a status text on the battler.
Used for information such as damage numbers, being downed, or missing a hit

@param x — The x-coordinate the message should appear at, relative to the battler.

@param y — The y-coordinate the message should appear at, relative to the battler.

@param type — The type of message to display:

@param arg — An additional argument which depends on what type is set to:

@param color — The color used to draw the status message, defaulting to white

@param kill — Whether this status should cause all other statuses to disappear.

@param delay — The number of frames before this message first appears

type:
    | "mercy" -- Indicates that the message will be a mercy number
    | "damage" -- Indicates that the message will be a damage number
    | "msg" -- Indicates that the message will use a unique sprite, such as MISS or DOWN text

arg:
    | "mercy" -- The amount of mercy added
    | "damage" -- The amount of damage dealt
    | "msg" -- The path to the sprite, relative to `ui/battle/message`, to use

Toggles the visibility of the overlay sprite versus main sprite.

@param overlay — Whether the overlay should be visible. If unset, will invert whatever the current visibility state is.

Internal variable used to store a callback for after an alert, if set.

Internal variable used to store the battler's overhead alert icon.

Internal timer variable for the battler's overhead alert icon.

The bubble style used for the battler. Defaults to "round" or "cyber", depending on chapter.

The offset of the dialogue bubble from its default position.

Internal timer variable for the battler's selected flash.

An instance of a white ColorMaskFX, used for the white flash when the battler is selected in a menu.

The number of times the battler has been hit recently, used for the stacking effect of damage numbers.

Internal variable used to determine whether the battler was highlighted last frame.

An overlay sprite being used by this battler - special animations such as being hurt or downed take place on this sprite as to preserve the main sprite's animation cycle afterwards.

The main sprite being used by this battler.

Actors are a type of data class that represent the visuals of a character - anything that is some type of character, be it the player, an NPC, or an enemy in battle, it will require an actor.
As a data class, actors are stored in scripts/data/actors/, and extend this class. Their filepath starting from here becomes their id, unless an id is specified as an argument to Class().

Actors are a type of data class that represent the visuals of a character - anything that is some type of character, be it the player, an NPC, or an enemy in battle, it will require an actor.
As a data class, actors are stored in scripts/data/actors/, and extend this class. Their filepath starting from here becomes their id, unless an id is specified as an argument to Class().