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

Inventory:addItem(item: any, ignore_convert: any)

Arguments:

item: any
ignore_convert: any

Returns:

1: Item|nil

Inventory:addItemTo(storage: any, index: any, item: any, allow_fallback: any)

Arguments:

storage: any
index: any
item: any
allow_fallback: any

Returns:

1: Item|nil


Inventory:getDefaultStorage(item_type: any, ignore_convert: any)

Arguments:

item_type: any
ignore_convert: any

Returns:

1: unknown|nil

Inventory:getFreeSpace(storage: any, allow_fallback: any)

Arguments:

storage: any
allow_fallback: any

Returns:

1: integer|unknown

Inventory:getItem(storage: any, index: any)

Arguments:

storage: any
index: any

Returns:

1: unknown

Inventory:getItemByID(item: any)

Arguments:

item: any

Returns:

1: unknown

Inventory:getItemCount(storage: any, allow_fallback: any)

Arguments:

storage: any
allow_fallback: any

Returns:

1: integer|unknown

Inventory:getItemIndex(item: any)

Arguments:

item: any

Returns:

1: unknown
2: unknown

Inventory:getNextIndex(storage: any, index: any, allow_fallback: any)

Arguments:

storage: any
index: any
allow_fallback: any

Returns:

1: unknown|nil
2: unknown|nil

Inventory:getStorage(type: any)

Arguments:

type: any

Returns:

1: unknown

Inventory:hasItem(item: any)

Arguments:

item: any

Returns:

1: boolean
2: unknown|nil

Inventory:isFull(storage: any, allow_fallback: any)

Arguments:

storage: any
allow_fallback: any

Returns:

1: boolean|nil

Inventory:load(data: any)

Arguments:

data: any

Inventory:loadStorage(storage: any, data: any)

Arguments:

storage: any
data: any

Inventory:removeItem(item: any)

Arguments:

item: any

Returns:

1: unknown|nil

Inventory:removeItemFrom(storage: any, index: any)

Arguments:

storage: any
index: any

Returns:

1: unknown|nil

Inventory:replaceItem(item: any, new: any)

Arguments:

item: any
new: any

Returns:

1: Item|nil

Inventory:save()

Returns:

1: table

Inventory:saveStorage(storage: any)

Arguments:

storage: any

Returns:

1: table

Inventory:setItem(storage: any, index: any, item: any)

Arguments:

storage: any
index: any
item: any

Returns:

1: Item|nil

Inventory:swapItems(storage1: any, index1: any, storage2: any, index2: any)

Arguments:

storage1: any
index1: any
storage2: any
index2: any

Inventory:tryGiveItem(item: any, ignore_convert: any)

Arguments:

item: any
ignore_convert: any

Returns:

1: boolean
2: unknown

Inventory:updateStoredItems(storage: any)

Arguments:

storage: any


Fields


Undocumented