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.


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

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.


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


MainMenu:drawAnimStrip(sprite: any, subimg: any, x: any, y: any, alpha: any)

Arguments:

sprite: any
subimg: any
x: any
y: any
alpha: any






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

Arguments:

key: any
is_repeat: any

MainMenu:onKeyReleased(key: any)

Arguments:

key: any


MainMenu:pushState(state: any, : unknown)

Arguments:

state: any
: unknown

MainMenu:setState(state: any, : unknown)

Arguments:

state: any
: unknown




Fields


Undocumented




MainMenu.animation_sine: number

Update background animation and alpha










MainMenu.background_image_wave: unknown

Assets required for the background animation







MainMenu.fader_alpha: integer

Initialize variables for the background animation


MainMenu.fader_alpha: integer

Change the fade opacity for the next frame













MainMenu.music: unknown

Load menu music "mod_menu", 1, 0.95






MainMenu.stage: unknown

Initialize variables for the menu


MainMenu.state: string

Register states



MainMenu.title_screen: unknown

Initialize all states