HomeWikiSourceDownloadsDiscord

Kristal Wiki


Getting Started


These pages get you ready to use the engine.

  • Downloading Kristal
  • Installing and Playing Mods

General Mod Creation


These pages teach you about mod development.

  • Understanding the Basics
  • Creating a Mod
  • Using Libraries
  • Creating an Item
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Mods

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes

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.

  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬Back to Top⮭

Kristal Wiki


Getting Started


These pages get you ready to use the engine.

  • Downloading Kristal
  • Installing and Playing Mods

General Mod Creation


These pages teach you about mod development.

  • Understanding the Basics
  • Creating a Mod
  • Using Libraries
  • Creating an Item
  • Creating a Spell
  • Actors
  • Party Members
  • Custom Keybinds
  • Releasing Mods

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes

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.

  • Hooks
  • The UI System

API Reference


An auto-generated API reference for Kristal.

⮬Back to Top⮭

ModButton

┗> Object > Class



Constructor


ModButton(name: any, width: any, height: any, mod: any)

Arguments:

name: any
width: any
height: any
mod: any




Methods


ModButton:checkCompatibility()

Returns:

1: boolean
2: unknown


ModButton:draw()



ModButton:getDrawColor()

Returns:

1: number|unknown
2: number|unknown
3: number|unknown
4: integer|unknown


ModButton:getFavoritedColor()

Returns:

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


ModButton:getHeartPos()

Returns:

1: integer
2: number


ModButton:getIconPos()

Returns:

1: number
2: integer


ModButton:hasSubtitle()

Returns:

1: boolean


ModButton:isFavorited()



ModButton:onDeselect()



ModButton:onSelect()



ModButton:setFavoritedColor(r: any, g: any, b: any, a: any)

Arguments:

r: any
g: any
b: any
a: any


ModButton:setName(name: any)

Arguments:

name: any


ModButton:setSubtitle(subtitle: any)

Arguments:

subtitle: any


ModButton:update()




Fields



Undocumented



ModButton.engine_versions: table



ModButton.engine_versions: table



ModButton.engine_versions: table



ModButton.favorited_color: table



ModButton.favorited_color: table



ModButton.font: unknown

temporary



ModButton.icon: table



ModButton.icon_delay: number



ModButton.icon_frame: integer



ModButton.icon_frame: number



ModButton.icon_frame: integer



ModButton.icon_frame: integer



ModButton.id: any



ModButton.mod: any



ModButton.name: any



ModButton.name: any



ModButton.selected: boolean



ModButton.selected: boolean



ModButton.selected: boolean



ModButton.subfont: unknown



ModButton.subtitle: unknown



ModButton.subtitle: any



ModButton.version: string


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