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.


Advanced

These pages teach you more complex but powerful parts of the engine.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

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.


Advanced

These pages teach you more complex but powerful parts of the engine.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

HealItem

┗> Item > Class


HealItem is an extension of Item that provides additional functionality for items that perform healing when used.
This class can be extended from in an item file instead of Item to include this functionality in the item.


Constructor




Methods

HealItem:getBattleHealAmount(id: string)

Gets the amount of HP this item should restore for a specific character when used in battle

@param id — The id of the character to get the HP amount for

Arguments:

id: string

The id of the character to get the HP amount for

Returns:

1: integer

HealItem:getBattleHealAmountModified(id: string, healer: PartyMember)

Applies Battle:applyHealBonuses() to the battle heal amount. Can be overriden to disable or change behaviour.

@param id — The id of the character to get the HP amount for

@param healer — The party member performing the heal action

Arguments:

id: string

The id of the character to get the HP amount for

healer: PartyMember

The party member performing the heal action

Returns:

1: number

HealItem:getHealAmount(id: string)

Gets the amount of HP this item should restore for a specific character

@param id — The id of the character to get the HP amount for

Arguments:

id: string

The id of the character to get the HP amount for

Returns:

1: integer

HealItem:getWorldHealAmount(id: string)

Gets the amount of HP this item should restore for a specific character when used in the world

@param id — The id of the character to get the HP amount for

Arguments:

id: string

The id of the character to get the HP amount for

Returns:

1: integer

HealItem:onBattleUse(user: PartyBattler, target: Battler[]|EnemyBattler|EnemyBattler[]|PartyBattler|PartyBattler[])

Modified to perform healing based on the set healing amounts

Arguments:

user: PartyBattler

PartyBattlers are a type of Battler that represent PartyMembers when they are in battle.
The set of PartyBattlers in the current battle are stored in Game.battle.party.
Unlike EnemyBattler, party members do not need to define a PartyBattler in a file as their PartyMember file defines everything necessary and is utilised by PartyBattler.

target: Battler[]|EnemyBattler|EnemyBattler[]|PartyBattler|PartyBattler[]

PartyBattlers are a type of Battler that represent PartyMembers when they are in battle.
The set of PartyBattlers in the current battle are stored in Game.battle.party.
Unlike EnemyBattler, party members do not need to define a PartyBattler in a file as their PartyMember file defines everything necessary and is utilised by PartyBattler.


HealItem:onWorldUse(target: PartyMember|PartyMember[])

Modified to perform healing based on the set healing amounts

Arguments:

target: PartyMember|PartyMember[]

The PartyMember class is a type of data class that stores information about a member of the party.
PartyMembers are stored in scripts/data/party, and extend this class. Their filepath starting from here becomes their id, unless an id is specified as an argument to Class().

Returns:

1: boolean


Fields


Undocumented