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
  • The UI System

The Overworld


Everything to do with the overworld.

  • Designing a Map
  • Cutscenes

Battles


Everything related to creating battles.

  • Battlers
  • Encounters

API Reference


An auto-generated API reference for Kristal.

⮬Back to Top⮭

Choicebox

┗> Object > Class


Constructor


Choicebox(x: any, y: any, width: any, height: any, battle_box: any, options: any)

Arguments:

x: any
y: any
width: any
height: any
battle_box: any
options: any




Methods


Choicebox:addChoice(name: any)

Arguments:

name: any


Choicebox:clearChoices()



Choicebox:draw()



Choicebox:getBorder()

Returns:

1: number|nil
2: number|nil


Choicebox:setColors(main: any, hover: any)

Arguments:

main: any
hover: any


Choicebox:setSize(w: any, h: any)

Arguments:

w: any
h: any


Choicebox:update()




Fields



Undocumented



Choicebox.active: boolean



Choicebox.battle_box: any



Choicebox.box: UIBox



Choicebox.choices: table



Choicebox.choices: table



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.current_choice: integer



Choicebox.done: boolean



Choicebox.done: boolean



Choicebox.font: love.Font|nil

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

Open in Browser



Choicebox.heart: love.Image|nil

Drawable image type.

Open in Browser



Choicebox.height: any



Choicebox.hover_colors: table



Choicebox.hover_colors: any



Choicebox.main_colors: table



Choicebox.main_colors: any



Choicebox.selected_choice: nil



Choicebox.selected_choice: integer



Choicebox.visible: boolean



Choicebox.width: any


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