RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======Item Storage Slot======
----

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

<WRAP center round info 100%>
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.
</WRAP>

=====Element Properties=====
^Icon^Property^Description^
|{{:wiki:tag_id.png?nolink|}}|Element ID|ID 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:**
<code bauxite>
$item_id = widget["test"].element["0001"].item.id;
$item_count = widget["test"].element["0001"].item.count
</code>

**Changing the item in an item storage slot:**
<code bauxite>
widget["test"].element["0001"].item = "ITEM_0001";
</code>

**Changing the count of an item in an item storage slot:**
<code bauxite>
widget["test"].element["0001"].count = 10;
</code>

**Checking if an item exists in an item storage slot:**
<code bauxite>
if widget["test"].element["0001"].item == null then
   display_message("There isn't an item in this slot.")
end
</code>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation