HomeWikiSourceDownloadsDiscord

Kristal Wiki


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project 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


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project 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 ⮭

LightEquipItem

┗> Item > Class


A class to extend from instead of Item when making equipment for the Light World.
Shares all the same variables and functions as Item


Methods

LightEquipItem:convertToDark(inventory: DarkInventory)

Arguments:

inventory: DarkInventory

A type of inventory used to store items in the Dark World.

Returns:

1: boolean|Item

LightEquipItem:convertToDarkEquip(chara: PartyMember)

Arguments:

chara: 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|Item


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

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

LightEquipItem:setArmor(i: any, item: any)

Arguments:

i: any
item: any

Returns:

1: Item|true

LightEquipItem:setArmorItems(armor_items: any)

Arguments:

armor_items: any