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

HealItem:getBattleHealAmount(id: any)

Arguments:

id: any

Returns:

1: integer|nil

HealItem:getHealAmount(id: any)

Arguments:

id: any

Returns:

1: integer

HealItem:getWorldHealAmount(id: any)

Arguments:

id: any

Returns:

1: integer|nil

HealItem:onBattleUse(user: any, target: any)

Arguments:

user: any
target: any

HealItem:onWorldUse(target: any)

Arguments:

target: any

Returns:

1: boolean


Fields


Undocumented


HealItem.battle_heal_amount: nil

Amount this item heals for in battle (optional)


HealItem.battle_heal_amounts: table

Amount this item heals for specific characters in battle (optional)


HealItem.heal_amount: integer

Amount this item heals


HealItem.heal_amounts: table

Amount this item heals for specific characters


HealItem.world_heal_amount: nil

Amount this item heals for in the overworld (optional)


HealItem.world_heal_amounts: table

Amount this item heals for specific characters in the overworld (optional)