Home Wiki Source Downloads Discord

Kristal Wiki

Getting Started

These pages get you ready to use the engine.

General Mod Creation

These pages teach you about mod development.

The Overworld

Everything to do with the overworld.

Battles

Everything related to creating battles.

API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Battle

┗> Object > Class

Constructor

Battle()

Methods

Battle:addMenuItem(tbl: any)

Arguments:

tbl: any

Returns:

Battle:advanceBoxes()

Battle:allActionsDone()

Returns:

Battle:battleText(text: any, post_func: any)

Arguments:

text: any
post_func: any

Battle:beginAction(action: any)

Arguments:

action: any

Battle:canDeepCopy()

Returns:

Battle:canSelectMenuItem(menu_item: any)

Arguments:

menu_item: any

Returns:

Battle:checkGameOver()

Battle:checkSolidCollision(collider: any)

Arguments:

collider: any

Returns:

1: boolean
2: Arena\|nil

Battle:clearActionIcon(battler: any)

Arguments:

battler: any

Battle:clearMenuItems()

Battle:commitAction(battler: any, action_type: any, target: any, data: any, extra: any)

Arguments:

battler: any
action_type: any
target: any
data: any
extra: any

Battle:commitSingleAction(action: any)

Arguments:

action: any

Battle:createPartyBattlers()

Battle:debugPrintOutline(string: any, x: any, y: any, color: any)

Arguments:

string: any
x: any
y: any
color: any

Battle:draw()

Battle:drawBackground()

Battle:drawDebug()

Battle:endActionAnimation(battler: any, action: any, callback: any)

Arguments:

battler: any
action: any
callback: any

Battle:finishAction(action: any, keep_animation: any)

Arguments:

action: any
keep_animation: any

Battle:finishActionBy(battler: any)

Arguments:

battler: any

Battle:finishAllActions()

Battle:getActionBy(battler: any, ignore_current: any)

Arguments:

battler: any
ignore_current: any

Returns:

Battle:getActiveEnemies()

Returns:

Battle:getActiveParty()

Returns:

Battle:getCurrentActing()

Returns:

Battle:getCurrentAction()

Returns:

Battle:getEncounterText()

Returns:

1: string|unknown|nil

Battle:getEnemyBattler(string_id: any)

Arguments:

string_id: any

Returns:

Battle:getEnemyFromCharacter(chara: any)

Arguments:

chara: any

Returns:

Battle:getItemIndex()

Returns:

Battle:getPartyBattler(string_id: any)

Arguments:

string_id: any

Returns:

Battle:getPartyFromTarget(target: any)

Arguments:

target: any

Returns:

Battle:getPartyIndex(string_id: any)

Arguments:

string_id: any

Returns:

Battle:getSoulLocation(always_origin: any)

Arguments:

always_origin: any

Returns:

1: number\|unknown\|nil
2: number\|unknown\|nil

Battle:getState()

Returns:

Battle:getTargetForItem(item: any, default_ally: any, default_enemy: any)

Arguments:

item: any
default_ally: any
default_enemy: any

Returns:

1: unknown[]|nil

Battle:handleActionSelectInput(key: any)

Arguments:

key: any

Battle:handleAttackingInput(key: any)

Arguments:

key: any

Battle:hasAction(character_id: any)

Arguments:

character_id: any

Returns:

Battle:hasCutscene()

Returns:

Battle:hurt(amount: any, exact: any, target: any)

Arguments:

amount: any
exact: any
target: any

Returns:

Battle:infoText(text: any)

Arguments:

text: any

Battle:isHighlighted(battler: any)

Arguments:

battler: any

Returns:

Battle:isValidMenuLocation()

Returns:

Battle:isWorldHidden()

Returns:

Battle:markAsFinished(action: any, keep_animation: any)

Arguments:

action: any
keep_animation: any

Battle:nextParty()

Battle:nextTurn()

Battle:onKeyPressed(key: any)

Arguments:

key: any

Battle:onRemove(parent: any)

Arguments:

parent: any

Battle:onStateChange(old: any, new: any)

Arguments:

old: any
new: any

Battle:onSubStateChange(old: any, new: any)

Arguments:

old: any
new: any

Battle:parseEnemyIdentifier(id: any)

Arguments:

id: any

Returns:

Battle:postInit(state: any, encounter: any)

Arguments:

state: any
encounter: any

Battle:powerAct(spell: any, battler: any, user: any, target: any)

Arguments:

spell: any
battler: any
user: any
target: any

Battle:previousParty()

Battle:processAction(action: any)

Arguments:

action: any

Returns:

1: boolean|unknown

Battle:processActionGroup(group: any)

Arguments:

group: any

Returns:

Battle:processCharacterActions()

Battle:pushAction(action_type: any, target: any, data: any, character_id: any, extra: any)

Arguments:

action_type: any
target: any
data: any
character_id: any
extra: any

Battle:pushForcedAction(battler: any, action: any, target: any, data: any, extra: any)

Arguments:

battler: any
action: any
target: any
data: any
extra: any

Battle:randomTarget()

Returns:

Battle:randomTargetOld()

Returns:

Battle:registerXAction(party: any, name: any, description: any, tp: any)

Arguments:

party: any
name: any
description: any
tp: any

Battle:removeAction(character_id: any)

Arguments:

character_id: any

Battle:removeEnemy(enemy: any, defeated: any)

Arguments:

enemy: any
defeated: any

Battle:removeSingleAction(action: any)

Arguments:

action: any

Battle:resetAttackers()

Battle:retargetEnemy()

Returns:

Battle:returnSoul(dont_destroy: any)

Arguments:

dont_destroy: any

Battle:returnToWorld()

Battle:setActText(text: any, dont_finish: any)

Arguments:

text: any
dont_finish: any

Battle:setSelectedParty(index: any)

Arguments:

index: any

Battle:setState(state: any, reason: any)

Arguments:

state: any
reason: any

Battle:setSubState(state: any, reason: any)

Arguments:

state: any
reason: any

Battle:setWaves(waves: any, allow_duplicates: any)

Arguments:

waves: any
allow_duplicates: any

Returns:

Battle:shakeCamera(x: any, y: any, friction: any)

Arguments:

x: any
y: any
friction: any

Battle:shortActText(text: any)

Arguments:

text: any

Battle:showUI()

Battle:sortChildren()

Battle:spawnSoul(x: any, y: any)

Arguments:

x: any
y: any

Battle:startActCutscene(group: any, id: any, dont_finish: any)

Arguments:

group: any
id: any
dont_finish: any

Returns:

1: Cutscene|nil

Battle:startCutscene(group: any, id: any, : unknown)

Arguments:

group: any
id: any
: unknown

Returns:

1: BattleCutscene

Battle:startProcessing()

Battle:swapSoul(object: any)

Arguments:

object: any

Battle:target(target: any)

Arguments:

target: any

Returns:

Battle:targetAll()

Returns:

Battle:targetAny()

Returns:

Battle:tryProcessNextAction(force: any)

Arguments:

force: any

Battle:update()

Battle:updateAttacking()

Battle:updateChildren()

Battle:updateIntro()

Battle:updateTransition()

Battle:updateTransitionOut()

Battle:updateWaves()

Fields

Undocumented

Battle.actions_done_timer: integer

Battle.actions_done_timer: number

Battle.actions_done_timer: number

Battle.afterimage_count: integer

Battle.afterimage_count: integer

Battle.arena: nil

Battle.arena: Arena

Battle.arena: nil

Battle.attack_done: boolean

Battle.attack_done: boolean

Battle.attack_done: boolean

Battle.attack_done: boolean

Battle.attackers: table

Battle.attackers: table

Battle.attackers: table

Battle.attackers: table

Battle.auto_attack_timer: integer

Battle.auto_attack_timer: integer

Battle.auto_attack_timer: number

Battle.auto_attackers: table

Battle.auto_attackers: table

Battle.auto_attackers: table

Battle.auto_attackers: table

Battle.background_fade_alpha: integer

Battle.background_fade_alpha: number

Battle.background_fade_alpha: number

Battle.battle_ui: nil

Battle.battle_ui: BattleUI

Battle.battler_targets: table

Battle.battler_targets: table

Battle.battletext_index: integer

Battle.battletext_table: nil

Battle.camera: Camera

Battle.cancel_attack: boolean

Battle.cancel_attack: boolean

Battle.cancel_attack: boolean

Battle.character_actions: table

Battle.character_actions: table

Battle.current_action_index: integer

Battle.current_action_index: integer

Battle.current_action_index: integer

Battle.current_action_processing: integer

Battle.current_actions: table

Battle.current_actions: table

Battle.current_button: integer

Battle.current_menu_x: integer

Battle.current_menu_x: integer

Battle.current_menu_x: integer

TODO: pagination

Battle.current_menu_x: integer

Battle.current_menu_x: integer

Battle.current_menu_x: integer

Battle.current_menu_x: integer

Battle.current_menu_x: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

No wrapping in this menu.

Battle.current_menu_y: integer

Battle.current_menu_y: integer

No wrapping in this menu.

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Keep decrementing until there's a selectable enemy.

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Keep decrementing until there's a selectable enemy.

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_menu_y: integer

Battle.current_processing_action: any

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: any

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.current_selecting: integer

Battle.cutscene: nil

Battle.cutscene: BattleCutscene

Battle.cutscene: nil

Battle.darkify: boolean

Battle.darkify: boolean

Battle.darkify: boolean

Battle.defeated_enemies: table

Battle.defending_begin_timer: integer

Battle.defending_begin_timer: integer

Battle.defending_begin_timer: number

Battle.encounter: Encounter|nil

Battle.encounter: any

Battle.encounter_context: nil

Battle.enemies: table

Battle.enemies_to_remove: table

Battle.enemies_to_remove: table

Battle.enemy_beginning_positions: table

Battle.enemy_dialogue: table

Battle.enemy_world_characters: table

Battle.finished_waves: boolean

Battle.finished_waves: boolean

Battle.finished_waves: boolean

Battle.has_acted: boolean

Battle.intro_timer: integer

Battle.intro_timer: integer

Battle.intro_timer: number

Battle.mask: ArenaMask

Battle.menu_items: table

Battle.menu_items: table

Battle.money: integer

Battle.money: unknown

Battle.money: integer

Battle.money: integer

Battle.money: integer

Battle.music: Music

Battle.normal_attackers: table

Battle.normal_attackers: table

Battle.normal_attackers: table

Battle.normal_attackers: table

Battle.offset: integer

Battle.offset: number

Battle.offset: integer

Battle.on_finish_action: nil

Battle.on_finish_action: any

Battle.on_finish_action: nil

Battle.on_finish_keep_animation: nil

Battle.on_finish_keep_animation: any

Battle.on_finish_keep_animation: nil

Battle.party: table

Battle.party_beginning_positions: table

Only used in TRANSITION, but whatever

Battle.party_world_characters: table

Battle.post_battletext_func: nil

Battle.post_battletext_state: string

Battle.processed_action: table

Battle.processed_action: table

Battle.processing_action: boolean

Battle.processing_action: unknown

Battle.processing_action: nil

Battle.resume_world_music: boolean

Battle.resume_world_music: boolean

Battle.seen_encounter_text: boolean

Battle.seen_encounter_text: boolean

Battle.seen_encounter_text: boolean

Battle.selected_action_stack: table

Battle.selected_action_stack: table

Battle.selected_character_stack: table

Battle.selected_character_stack: table

Battle.selected_enemy: integer

Battle.selected_enemy: integer

Battle.selected_enemy: integer

Battle.selected_item: nil

Battle.selected_spell: nil

Battle.selected_xaction: nil

Battle.short_actions: table

Battle.short_actions: table

Battle.short_actions: table

Battle.should_finish_action: boolean

Battle.should_finish_action: boolean

Battle.should_finish_action: boolean

Battle.soul: nil

Battle.soul: Soul|nil

Battle.soul: any

Battle.spare_sound: love.Source|nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser

Battle.spell_delay: integer

Battle.spell_finished: boolean

Battle.started: boolean

Battle.started: boolean

Battle.state: string

Battle.state: any

Battle.state: any

Battle.state_reason: nil

Battle.state_reason: any

Battle.substate: string

Battle.substate: any

Battle.substate_reason: nil

Battle.substate_reason: any

Battle.tension_bar: nil

Battle.tension_bar: TensionBar

Battle.textbox_timer: integer

Battle.textbox_timer: integer

Battle.textbox_timer: number

Battle.textbox_timer: integer

Battle.timer: Timer

Battle.transition_timer: integer

Battle.transition_timer: integer

Battle.transition_timer: integer

Battle.transition_timer: number

Battle.transition_timer: integer

Battle.transition_timer: number

Battle.transitioned: boolean

Battle.transitioned: boolean

Battle.turn_count: integer

Battle.turn_count: integer

Battle.ui_move: love.Source|nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser

Battle.ui_select: love.Source|nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser

Battle.update_child_list: boolean

Battle.use_textbox_timer: boolean

Battle.use_textbox_timer: boolean

Battle.use_textbox_timer: boolean

Battle.used_violence: boolean

Battle.wave_length: integer

Battle.wave_length: integer

Battle.wave_length: integer

Battle.wave_timer: integer

Battle.wave_timer: integer

Battle.wave_timer: number

Battle.waves: table

Battle.waves: table

Battle.waves: table

Battle.xactions: table

Battle.xp: integer

Battle.xp: integer