Home
Wiki
Source
Downloads
Discord

Kristal Wiki


General Information


These pages get you ready to use the engine.

  • Main Page
  • Downloading Kristal
  • Installing and Playing Projects
  • Glossary

General Project Creation


These pages teach you about project development.

  • Lua Tutorial
  • Understanding the Basics
  • Creating a Project
  • Writing Text
  • Using Libraries
  • Creating an Item
  • Creating a Shop
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Projects

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes
  • Map Properties and Layers
  • Events
  • Battle Areas
  • The World Tool

Battles


Everything related to creating battles.

  • Battlers
  • Encounters
  • Enemy Attacks (Waves)
  • Wavemaking Tricks and References

Advanced


These pages teach you more complex but powerful parts of the engine.

  • Debugging
  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

Kristal Wiki


General Information


These pages get you ready to use the engine.

  • Main Page
  • Downloading Kristal
  • Installing and Playing Projects
  • Glossary

General Project Creation


These pages teach you about project development.

  • Lua Tutorial
  • Understanding the Basics
  • Creating a Project
  • Writing Text
  • Using Libraries
  • Creating an Item
  • Creating a Shop
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Projects

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes
  • Map Properties and Layers
  • Events
  • Battle Areas
  • The World Tool

Battles


Everything related to creating battles.

  • Battlers
  • Encounters
  • Enemy Attacks (Waves)
  • Wavemaking Tricks and References

Advanced


These pages teach you more complex but powerful parts of the engine.

  • Debugging
  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

BattleUI

┗> Object > Class



Constructor


BattleUI()





Methods


BattleUI:beginAttack()



BattleUI:clearEncounterText()



BattleUI:draw()



BattleUI:drawActionArena()



BattleUI:drawActionStrip()



BattleUI:drawState()



BattleUI:endAttack()



BattleUI:getTransitionBounds()

Returns:

1: integer
2: integer


BattleUI:resetXACTPosition()



BattleUI:transitionIn()



BattleUI:transitionOut()



BattleUI:update()




Undocumented



BattleUI.action_boxes: table



BattleUI.animate_out: boolean



BattleUI.animation_done: boolean



BattleUI.animation_timer: integer



BattleUI.animation_y: integer



BattleUI.animation_y_lag: integer



BattleUI.arrow_sprite: love.Image

Drawable image type.

Open in Browser



BattleUI.attack_boxes: table



BattleUI.attacking: boolean



BattleUI.choice_box: Choicebox



BattleUI.current_encounter_text: table



BattleUI.encounter_text: Textbox



BattleUI.heart_sprite: love.Image

Drawable image type.

Open in Browser



BattleUI.layer: integer



BattleUI.parallax_x: integer



BattleUI.parallax_y: integer



BattleUI.short_act_text_1: DialogueText

The DialogueText object displays text letter-by-letter.



BattleUI.short_act_text_2: DialogueText

The DialogueText object displays text letter-by-letter.



BattleUI.short_act_text_3: DialogueText

The DialogueText object displays text letter-by-letter.



BattleUI.shown: boolean



BattleUI.sparestar: love.Image

Drawable image type.

Open in Browser



BattleUI.tiredmark: love.Image

Drawable image type.

Open in Browser



BattleUI.xact_x_pos: integer



BattleUI.y: number


DELTARUNE by Toby Fox.
Website designed by NyakoFox.
© 2026 Kristal Team. All rights reserved.