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




Methods


Spell:getCastMessage(user: any, target: any)

Arguments:

user: any
target: any

Returns:

1: unknown



Spell:getName()

Returns:

1: string

Spell:getTPCost(chara: any)

Arguments:

chara: any

Returns:

1: integer

Spell:hasTag(tag: any)

Arguments:

tag: any

Returns:

1: boolean

Spell:hasWorldUsage(chara: any)

Arguments:

chara: any

Returns:

1: boolean

Spell:isUsable(chara: any)

Arguments:

chara: any

Returns:

1: boolean

Spell:onCast(user: any, target: any)

Arguments:

user: any
target: any

Spell:onDeselect(user: any, target: any)

Arguments:

user: any
target: any

Spell:onSelect(user: any, target: any)

Arguments:

user: any
target: any

Spell:onStart(user: any, target: any)

Arguments:

user: any
target: any

Spell:onWorldCast(chara: any)

Arguments:

chara: any


Fields


Undocumented


Spell.cast_name: nil

Name displayed when cast (optional)



Spell.description: string

Menu description


Spell.effect: string

Battle description


Spell.name: string

Display name


Spell.tags: table

Tags that apply to this spell


Spell.target: string

Target mode (ally, party, enemy, enemies, or none)


Spell.usable: boolean

Whether the spell can be used