Methods
Registry.createMap(id: string, world: World, : any)
Arguments:
id: string | |
world: World | The |
: any |
Returns:
1: Map |
Registry.getBattleCutscene(group: string, id: string?)
Arguments:
group: string | |
id: string? |
Returns:
cutscene: function|nil | |
grouped: boolean|nil |
Registry.getEventScript(group: string, id: string?)
Arguments:
group: string | |
id: string? |
Returns:
cutscene: function|nil | |
grouped: boolean|nil |
Registry.getLegendCutscene(group: string, id: string?)
Arguments:
group: string | |
id: string? |
Returns:
cutscene: function|nil | |
grouped: boolean|nil |
Registry.getWorldCutscene(group: string, id: string?)
Arguments:
group: string | |
id: string? |
Returns:
cutscene: function|nil | |
grouped: boolean|nil |
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 | Actors are a type of data class that represent the visuals of a character - anything that is some type of character, be it the player, an NPC, or an enemy in battle, it will require an 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 | The class that all Battle bullets in Kristal originate from. |
Registry.registerController(id: string, class: Event|Object)
Arguments:
id: string | |
class: Event|Object | Events are used as the base class for objects in the Overworld (in most cases)
Custom events should be defined in |
Registry.registerEncounter(id: string, class: Encounter)
Arguments:
id: string | |
class: Encounter | Encounters detail the setup of unique battles in Kristal, from the enemies that appear to the environment and special mechanics. |
Registry.registerEnemy(id: string, class: EnemyBattler)
Arguments:
id: string | |
class: EnemyBattler |
Recruit data is separate to enemies, see |
Registry.registerEvent(id: string, class: Event|Object)
Arguments:
id: string | |
class: Event|Object | Events are used as the base class for objects in the Overworld (in most cases)
Custom events should be defined in |
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 | The Item class represents all types of item in Kristal. |
Registry.registerLegendCutscene(id: string, cutscene: function|table<string, function>)
Arguments:
id: string | |
cutscene: function|table<string, function> |
Registry.registerMap(id: string, class: Map)
Arguments:
id: string | |
class: Map | Stores and manages the currently loaded map. |
Registry.registerPartyMember(id: string, class: PartyMember)
Arguments:
id: string | |
class: PartyMember | The PartyMember class is a type of data class that stores information about a member of the party. |
Registry.registerRecruit(id: string, class: Recruit)
Arguments:
id: string | |
class: Recruit | Recruits are data files that define the properties of recruitable enemies. |
Registry.registerShop(id: string, class: Shop)
Arguments:
id: string | |
class: Shop | The class which all Shops in Kristal use. |
Registry.registerSpell(id: string, class: Spell)
Arguments:
id: string | |
class: Spell | Spells are data files that extend this |
Registry.registerWave(id: string, class: Wave)
Arguments:
id: string | |
class: Wave | Waves are the bullet patterns that enemies use in battle. |
Registry.registerWorldBullet(id: string, class: WorldBullet)
Arguments:
id: string | |
class: WorldBullet | The class that all World bullets in Kristal originate from. |
Registry.registerWorldCutscene(id: string, cutscene: function|table<string, function>)
Arguments:
id: string | |
cutscene: function|table<string, function> |