User Tools

Site Tools


equipment_slot

Equipment Slot


An equipment slot is a widget element for equipping an item to (for example, a sword or shield). The player can equip an item to the slot if the item has been configured as equippable in the Item Editor and it includes a tag matching the slot ID assigned to the equipment slot.

Element Properties

IconPropertyDescription
Element IDID for the equipment 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.
Equipment Slot IDID that will determine which items can be equipped to this slot. For example, if the Equipment Slot ID is configured as “head”, the slot will only allow items that include a tag of “head” (e.g. an iron helmet).

Scripting

You can access certain properties of an equipment 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 equipment slot has an ID of “0001”. If the slot is empty, its “item” property will be null.

Retrieving the item data for an equipment slot:

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

Checking if an item exists in an equipment slot:

if widget["test"].element["0001"].item == null then
   display_message("There isn't an item in this slot.")
end
equipment_slot.txt · Last modified: 2020/12/06 21:03 by justin