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 ⮭

ModCreateButton

┗> Object > Class



Constructor


ModCreateButton(width: number, height: number)

Arguments:

width: number
height: number




Methods


ModCreateButton:draw()



ModCreateButton:getDrawColor()

Returns:

1: number
2: number
3: number
4: integer


ModCreateButton:getHeartPos()

Returns:

1: integer
2: number


ModCreateButton:getIconPos()

Returns:

1: number
2: integer


ModCreateButton:onDeselect()



ModCreateButton:onSelect()



ModCreateButton:update()




Undocumented



ModCreateButton.font: love.Font

temporary



ModCreateButton.name: string



ModCreateButton.selected: boolean



ModCreateButton.subfont: love.Font

Defines the shape of characters that can be drawn onto the screen.

Open in Browser



ModCreateButton.subtitle: string


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