HomeWikiSourceDownloadsDiscord

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

DebugSystem:addToExclusiveMenu(state: any, id: any)

Arguments:

state: any
id: any

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:fadeMusicOut(fade_to: any)

Arguments:

fade_to: 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, sx: any, sy: any)

Arguments:

text: any
x: any
y: any
color: any
align: any
limit: any
sx: any
sy: 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:registerMenuEntry(id: any, func: any)

Arguments:

id: any
func: any

DebugSystem:registerMenuLeave(id: any, func: any)

Arguments:

id: any
func: any

DebugSystem:registerOption(menu: string, name: string, description: string|fun()string, func: function, visible_func: (fun()boolean)?, color: fun(){ [1]? }?)

Arguments:

menu: string
name: string
description: string|fun()string
func: function
visible_func: (fun()boolean)?
color: fun(){ [1]? }?

Returns:

1: nil



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:startTextInput(tbl: any)

Arguments:

tbl: any



DebugSystem:updateBounds(options: number|table)

Arguments:

options: number|table


Fields

DebugSystem.filtered_flags_list: string[]

A list of filtered flag keys that should show in the flags menu

DebugSystem.flag_filter_mode: string

The current flag filter mode

DebugSystem.flag_query: string }

The current flag filter query

DebugSystem.flag_type: string

The current flag filter setting for value type

DebugSystem.temp_flag_filter_mode: string

Temporary version of flag_filter_mode. Only set as filter once the settings are saved.

DebugSystem.temp_flag_query: string }

Temporary version of flag_query. Only set as filter once the settings are saved.

DebugSystem.temp_flag_type: string

Temporary version of flag_type. Only set as filter once the settings are saved.


Undocumented











DebugSystem.current_text_align: string





DebugSystem.font: love.Font

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

Open in Browser







DebugSystem.heart: Sprite

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










DebugSystem.menu_entry_callbacks: table












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.state: string

States: IDLE, MENU, SELECTION, FACES