Home
Wiki
Source
Downloads
Discord

Kristal Wiki


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


Advanced

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


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.


General Project Creation

These pages teach you about project development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


Advanced

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


API Reference

An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

Constructor




Methods

DarkMenu:addButton(button: any, index: any)

Arguments:

button: any
index: any

Returns:

1: unknown




DarkMenu:drawButton(index: any, x: any, y: any)

Arguments:

index: any
x: any
y: any

DarkMenu:getButton(id: any)

Arguments:

id: any

Returns:

1: unknown


DarkMenu:onAdd(parent: Object)

Arguments:

parent: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.


DarkMenu:onButtonSelect(button_index: any)

Arguments:

button_index: any

DarkMenu:onKeyPressed(key: any)

Arguments:

key: any

DarkMenu:partySelect(mode: any, after: any)

Arguments:

mode: any
after: any

DarkMenu:setDescription(text: any, visible: any)

Arguments:

text: any
visible: any





Undocumented










DarkMenu.description: Text

The Text object, made for displaying formatted text.

If you're looking for text which writes itself out over time, see DialogueText.




DarkMenu.font: love.Font

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

Open in Browser
















DarkMenu.ui_cancel_small: Sound

The sound class. This is a transparent wrapper over Love2D's Source.


DarkMenu.ui_cant_select: Sound

The sound class. This is a transparent wrapper over Love2D's Source.


DarkMenu.ui_move: Sound

The sound class. This is a transparent wrapper over Love2D's Source.


DarkMenu.ui_select: Sound

The sound class. This is a transparent wrapper over Love2D's Source.