HomeWikiSourceDownloadsDiscord

Kristal Wiki

Getting Started

These pages get you ready to use the engine.


General Mod Creation

These pages teach you about mod development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Constructor




Methods

DebugSystem:appendBool(desc: any, bool: any)

Arguments:

desc: any
bool: any

Returns:

1: unknown



DebugSystem:copyObject(object: any)

Arguments:

object: any

DebugSystem:cutObject(object: any)

Arguments:

object: any

DebugSystem:detectObject(x: any, y: any)

Arguments:

x: any
y: any

Returns:

1: unknown|nil


DebugSystem:enterMenu(menu: any, soul: any, skip_history: any)

Arguments:

menu: any
soul: any
skip_history: any






DebugSystem:onKeyPressed(key: any, is_repeat: any)

Arguments:

key: any
is_repeat: any

DebugSystem:onKeyReleased(key: any)

Arguments:

key: any

DebugSystem:onMousePressed(x: any, y: any, button: any, istouch: any, presses: any)

Arguments:

x: any
y: any
button: any
istouch: any
presses: any

DebugSystem:onMouseReleased(x: any, y: any, button: any, istouch: any, presses: any)

Arguments:

x: any
y: any
button: any
istouch: any
presses: any

DebugSystem:onStateChange(old: any, new: any)

Arguments:

old: any
new: any

DebugSystem:onWheelMoved(x: any, y: any)

Arguments:

x: any
y: any


DebugSystem:openObjectContext(object: any)

Arguments:

object: any


DebugSystem:pasteObject(object: any)

Arguments:

object: any

DebugSystem:printShadow(text: any, x: any, y: any, color: any, align: any, limit: any)

Arguments:

text: any
x: any
y: any
color: any
align: any
limit: any


DebugSystem:registerConfigOption(menu: any, name: any, description: any, value: any, callback: any)

Arguments:

menu: any
name: any
description: any
value: any
callback: any


DebugSystem:registerMenu(id: any, name: any, type: any)

Arguments:

id: any
name: any
type: any

DebugSystem:registerOption(menu: any, name: any, description: any, func: any, visible_func: any)

Arguments:

menu: any
name: any
description: any
func: any
visible_func: any



DebugSystem:selectObject(object: any)

Arguments:

object: any


DebugSystem:setState(state: any, reason: any)

Arguments:

state: any
reason: any

DebugSystem:sortMenuOptions(options: any, filter: any)

Arguments:

options: any
filter: any




DebugSystem:updateBounds(options: any)

Arguments:

options: any


Fields


Undocumented









































DebugSystem.current_text_align: string


DebugSystem.current_text_align: string






DebugSystem.font: love.Font|nil

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

Open in Browser











DebugSystem.grabbing: boolean

right clicking should not drag







DebugSystem.heart: Sprite

A simple object that renders a texture.
This texture must be placed inside assets/sprites/.























































DebugSystem.playing_sound: nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser


DebugSystem.playing_sound: love.Source|nil

A Source represents audio you can play back.

You can do interesting things with Sources, like set the volume, pitch, and its position relative to the listener. Please note that positional audio only works for mono (i.e. non-stereo) sources.

The Source controls (play/pause/stop) act according to the following state table.

Open in Browser






DebugSystem.search_text: table





DebugSystem.state: string

States: IDLE, MENU, SELECTION, FACES