User Tools

Site Tools


item_storage_slot

Item Storage Slot


An item storage slot is a widget element for storing an item or stack of items. This is useful for inventory windows, item container windows, or other widgets that are meant for storing items into for later retrieval and usage.

When left-clicking to remove an item from a storage slot that is stacked, you can hold down the Control key to pick up only one of the item instead of the entire stack.

Element Properties

IconPropertyDescription
Element IDID for the item storage slot. This ID must be unique amongst other elements within the same widget. It is currently auto-generated but will be editable in a future update.

Scripting

You can access certain properties of an item storage slot from a script by simply referencing the parent widget and the element by their unique IDs. See below for examples of retrieving the slot's item. In this case, we are assuming that the slot currently contains an item, the widget has an ID of “test”, and the item storage slot has an ID of “0001”. If the slot is empty, its “item” property will be null.

Retrieving the item data for an item storage slot:

$item_id = widget["test"].element["0001"].item.id;
$item_count = widget["test"].element["0001"].item.count

Changing the item in an item storage slot:

widget["test"].element["0001"].item = "ITEM_0001";

Changing the count of an item in an item storage slot:

widget["test"].element["0001"].count = 10;

Checking if an item exists in an item storage slot:

if widget["test"].element["0001"].item == null then
   display_message("There isn't an item in this slot.")
end
item_storage_slot.txt · Last modified: 2024/02/18 21:45 by justin