Kristal Wiki

General Information

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.

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 Mod Creation

These pages teach you about mod 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⮭

DebugSystem

┗> Object > Class

Constructor

DebugSystem()

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:closeMenu()

DebugSystem:closeSelection()

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:draw()

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

Arguments:

menu: any
soul: any
skip_history: any

DebugSystem:fadeMusicIn()

DebugSystem:fadeMusicOut(fade_to: any)

Arguments:

fade_to: any

DebugSystem:getStage()

Returns:

1: unknown

DebugSystem:getValidOptions()

Returns:

1: table

DebugSystem:isMenuOpen()

Returns:

1: boolean

DebugSystem:leaveMenu()

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:openMenu()

DebugSystem:openObjectContext(object: any)

Arguments:

object: any

DebugSystem:openSelection()

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:refresh()

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

Arguments:

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

DebugSystem:registerDefaults()

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)?)

Arguments:

menu: string
name: string
description: string\|fun()string
func: function
visible_func: (fun()boolean)?

Returns:

1: nil

DebugSystem:registerSubMenus()

DebugSystem:returnMenu()

DebugSystem:selectObject(object: any)

Arguments:

object: any

DebugSystem:selectionOpen()

Returns:

1: boolean

DebugSystem:setFlagFilterDefaults()

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:unselectObject()

DebugSystem:update()

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.circle_anim_timer: integer

DebugSystem.circle_anim_timer: number

DebugSystem.clicked_name: nil

DebugSystem.clicked_name: unknown

DebugSystem.context: nil

DebugSystem.context: ContextMenu

DebugSystem.context: unknown

DebugSystem.copied_object: nil

DebugSystem.copied_object: unknown

DebugSystem.copied_object: any

DebugSystem.copied_object: nil

DebugSystem.copied_object_parent: nil

DebugSystem.copied_object_parent: unknown

DebugSystem.copied_object_parent: nil

DebugSystem.copied_object_temp: boolean

DebugSystem.current_menu: string

DebugSystem.current_menu: any

DebugSystem.current_selecting: integer

DebugSystem.current_selecting: any

DebugSystem.current_selecting: number

DebugSystem.current_selecting: integer

DebugSystem.current_selecting: number

DebugSystem.current_selecting: integer

DebugSystem.current_selecting: number

DebugSystem.current_selecting: unknown

DebugSystem.current_selecting: number

DebugSystem.current_selecting: integer

DebugSystem.current_selecting: number

DebugSystem.current_subselecting: any

DebugSystem.current_text_align: string

DebugSystem.exclusive_menus: table

DebugSystem.faces_y: integer

DebugSystem.faces_y: unknown

DebugSystem.faces_y: number

DebugSystem.flash_fx: ColorMaskFX

DebugSystem.font: love.Font

DebugSystem.font_name: string

DebugSystem.font_size: integer

DebugSystem.grab_offset_x: integer

DebugSystem.grab_offset_x: unknown

DebugSystem.grab_offset_y: integer

DebugSystem.grab_offset_y: unknown

DebugSystem.grabbing: boolean

right clicking should not drag

DebugSystem.grabbing: boolean

DebugSystem.heart: Sprite

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

DebugSystem.heart_target_x: integer

DebugSystem.heart_target_y: integer

DebugSystem.heart_target_y: number

DebugSystem.hover_alpha: integer

DebugSystem.hover_alpha: number

DebugSystem.hover_alpha: integer

DebugSystem.hover_alpha: number

DebugSystem.last_context: nil

DebugSystem.last_context: ContextMenu

DebugSystem.last_hovered: nil

DebugSystem.last_hovered: any

DebugSystem.last_object: nil

DebugSystem.last_object: any

DebugSystem.last_object: nil

DebugSystem.layer: integer

DebugSystem.menu_anim_timer: integer

DebugSystem.menu_anim_timer: number

0.5 seconds

DebugSystem.menu_entry_callbacks: table

DebugSystem.menu_history: table

DebugSystem.menu_leave_callbacks: table

DebugSystem.menu_target_y: integer

DebugSystem.menu_target_y: unknown

DebugSystem.menu_target_y: number

DebugSystem.menu_target_y: integer

DebugSystem.menu_y: integer

DebugSystem.menu_y: number

DebugSystem.menus: table

DebugSystem.mouse_clicked: boolean

DebugSystem.music: unknown

DebugSystem.music_needs_reset: boolean

DebugSystem.object: nil

DebugSystem.object: any

DebugSystem.object: nil

DebugSystem.old_music_volume: integer

DebugSystem.old_music_volume: number

DebugSystem.old_state: string

DebugSystem.old_state: any

DebugSystem.playing_sound: nil

DebugSystem.playing_sound: love.Source

DebugSystem.release_timer: integer

DebugSystem.release_timer: number

DebugSystem.release_timer: integer

DebugSystem.search: table

DebugSystem.selected_alpha: integer

DebugSystem.selected_alpha: number

DebugSystem.state: string

States: IDLE, MENU, SELECTION, FACES