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

StateManager(default_state: any, master: any, update_master_state: any)

Arguments:

default_state: any
master: any
update_master_state: any



Methods

StateManager:addEvent(event: any, state_callbacks: any)

Arguments:

event: any
state_callbacks: any

StateManager:addState(state: any, events: any)

Arguments:

state: any
events: any

StateManager:call(event: any, : unknown)

Arguments:

event: any
: unknown

StateManager:callOn(state: any, event: any, : unknown)

Arguments:

state: any
event: any
: unknown



StateManager:getHandler(state: any)

Arguments:

state: any

Returns:

1: unknown

StateManager:hasEvent(event: any, state: any)

Arguments:

event: any
state: any

Returns:

1: unknown

StateManager:hasState(state: any)

Arguments:

state: any

Returns:

1: boolean

StateManager:hook(state: any, event: any, func: any)

Arguments:

state: any
event: any
func: any

StateManager:popState(: unknown)

(Experimental)

Arguments:

: unknown

StateManager:pushState(state: any, : unknown)

(Experimental)

Arguments:

state: any
: unknown

StateManager:removeEvent(event: any)

Arguments:

event: any

StateManager:removeState(state: any)

Arguments:

state: any

StateManager:setState(state: any, : unknown)

Arguments:

state: any
: unknown



Fields


Undocumented



































StateManager.update_master_state: any

If true, sets self.master.state and updates state if a change in self.master.state is detected