Home Wiki Source Downloads Discord

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⮭

Registry

Methods

Registry.createActor(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createBullet(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createController(id: string, : any)

Arguments:

id: string
: any

Returns:

1: Event|Object

Registry.createDrawFX(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createEncounter(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createEnemy(id: string, : any)

Arguments:

id: string
: any

Returns:

1: EnemyBattler

Registry.createEvent(id: string, : any)

Arguments:

id: string
: any

Returns:

1: Event|Object

Registry.createItem(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createMap(id: string, world: World, : any)

Arguments:

id: string
world: World
: any

Returns:

1: Map

Registry.createObject(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createPartyMember(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createShop(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createSpell(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createWave(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.createWorldBullet(id: string, : any)

Arguments:

id: string
: any

Returns:

Registry.getActor(id: string)

Arguments:

Returns:

Registry.getBattleCutscene(group: string, id: string?)

Arguments:

group: string
id: string?

Returns:

cutscene: function\|nil
grouped: boolean\|nil

Registry.getBullet(id: string)

Arguments:

Returns:

Registry.getController(id: string)

Arguments:

Returns:

1: Event|Object|nil

Registry.getDrawFX(id: string)

Arguments:

Returns:

Registry.getEncounter(id: string)

Arguments:

Returns:

1: Encounter|nil

Registry.getEnemy(id: string)

Arguments:

Returns:

1: EnemyBattler|nil

Registry.getEvent(id: string)

Arguments:

Returns:

1: Event|Object|nil

Registry.getEventScript(group: string, id: string?)

Arguments:

group: string
id: string?

Returns:

cutscene: function\|nil
grouped: boolean\|nil

Registry.getItem(id: string)

Arguments:

Returns:

Registry.getMap(id: string)

Arguments:

Returns:

Registry.getMapData(id: string)

Arguments:

Returns:

Registry.getObject(id: string)

Arguments:

Returns:

Registry.getPartyMember(id: string)

Arguments:

Returns:

1: PartyMember|nil

Registry.getShop(id: string)

Arguments:

Returns:

Registry.getSpell(id: string)

Arguments:

Returns:

Registry.getTileset(id: string)

Arguments:

Returns:

Registry.getWave(id: string)

Arguments:

Returns:

Registry.getWorldBullet(id: string)

Arguments:

Returns:

1: WorldBullet|nil

Registry.getWorldCutscene(group: string, id: string?)

Arguments:

group: string
id: string?

Returns:

cutscene: function\|nil
grouped: boolean\|nil

Registry.initActors()

Registry.initBullets()

Registry.initControllers()

Registry.initCutscenes()

Registry.initDrawFX()

Registry.initEncounters()

Registry.initEnemies()

Registry.initEventScripts()

Registry.initEvents()

Registry.initGlobals()

Registry.initItems()

Registry.initMaps()

Registry.initObjects()

Registry.initPartyMembers()

Registry.initShops()

Registry.initSpells()

Registry.initTilesets()

Registry.initWaves()

Registry.initialize(preload: boolean?)

Arguments:

preload: boolean?

Registry.iterScripts(base_path: string, exclude_folder: boolean?)

Arguments:

base_path: string
exclude_folder: boolean?

Returns:

1: fun()string?, string?, ...unknown

Registry.registerActor(id: string, class: Actor)

Arguments:

id: string
class: Actor

Registry.registerBattleCutscene(id: string, cutscene: function|table<string, function>)

Arguments:

id: string
cutscene: function\|table<string, function>

Registry.registerBullet(id: string, class: Bullet)

Arguments:

id: string
class: Bullet

Registry.registerController(id: string, class: Event|Object)

Arguments:

id: string
class: Event\|Object	The base class of all objects in Kristal. When added to the stage, an object will be updated and rendered.

Registry.registerEncounter(id: string, class: Encounter)

Arguments:

id: string
class: Encounter

Registry.registerEnemy(id: string, class: EnemyBattler)

Arguments:

id: string
class: EnemyBattler

Registry.registerEvent(id: string, class: Event|Object)

Arguments:

id: string
class: Event\|Object	The base class of all objects in Kristal. When added to the stage, an object will be updated and rendered.

Registry.registerEventScript(id: string, script: function|table<string, function>)

Arguments:

id: string
script: function\|table<string, function>

Registry.registerGlobal(id: string, value: any, no_warning: boolean?)

Arguments:

id: string
value: any
no_warning: boolean?

Registry.registerItem(id: string, class: Item)

Arguments:

id: string
class: Item

Registry.registerMap(id: string, class: Map)

Arguments:

id: string
class: Map

Registry.registerMapData(id: string, data: table)

Arguments:

id: string
data: table

Registry.registerPartyMember(id: string, class: PartyMember)

Arguments:

id: string
class: PartyMember

Registry.registerShop(id: string, class: Shop)

Arguments:

id: string
class: Shop

Registry.registerSpell(id: string, class: Spell)

Arguments:

id: string
class: Spell

Registry.registerTileset(id: string, class: Tileset)

Arguments:

id: string
class: Tileset

Registry.registerWave(id: string, class: Wave)

Arguments:

id: string
class: Wave

Registry.registerWorldBullet(id: string, class: WorldBullet)

Arguments:

id: string
class: WorldBullet

Registry.registerWorldCutscene(id: string, cutscene: function|table<string, function>)

Arguments:

id: string
cutscene: function\|table<string, function>

Registry.restoreOverridenGlobals()

Fields

Registry.actors: table<string, Actor>

Registry.base_scripts: table<string, function>

Registry.battle_cutscenes: table<string, function|table<string, function>>

Registry.bullets: table<string, Bullet>

Registry.controllers: table<string, Event|Object>

Registry.draw_fx: table<string, DrawFX>

Registry.encounters: table<string, Encounter>

Registry.enemies: table<string, EnemyBattler>

Registry.event_scripts: table<string, function|table<string, function>>

Registry.events: table<string, Event|Object>

Registry.items: table<string, Item>

Registry.last_globals: table

Registry.map_data: table<string, table>

TODO: Document map data

Registry.maps: table<string, Map>

Registry.new_globals: table

Registry.objects: table<string, Object>

Registry.party_members: table<string, PartyMember>

Registry.paths: table<string, string>

Registry.preload: boolean?

Registry.shops: table<string, Shop>

Registry.spells: table<string, Spell>

Registry.tilesets: table<string, Tileset>

Registry.waves: table<string, Wave>

Registry.world_bullets: table<string, WorldBullet>

Registry.world_cutscenes: table<string, function|table<string, function>>

Undocumented