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

ModList(x: any, y: any, width: any, height: any)

Arguments:

x: any
y: any
width: any
height: any



Methods

ModList:addMod(mod: any)

Arguments:

mod: any



ModList:getById(id: any)

Arguments:

id: any

Returns:

1: unknown
2: integer





ModList:pageDown(no_wrap: any)

Arguments:

no_wrap: any

ModList:pageUp(no_wrap: any)

Arguments:

no_wrap: any

ModList:select(i: any, mute: any)

Arguments:

i: any
mute: any

Returns:

1: boolean

ModList:selectDown(no_wrap: any)

Arguments:

no_wrap: any

ModList:selectUp(no_wrap: any)

Arguments:

no_wrap: any

ModList:setScroll(scroll: any)

Arguments:

scroll: any



Fields


Undocumented


ModList.mod_container: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.