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.

======Add Item To Container======
----

Adds one or more of the specified [[item|item]] to an [[item_container|item container]]. The ID of the [[item|item]] is case-sensitive and should match the ID assigned to it in the [[item_editor|Item Editor]] (e.g. "ITEM_0001"). The [[item|item(s)]] will be placed into the first open slot(s) of the [[item_container|container]].

====Signature:====
<code python>
add_item_to_container(entity, item_id, count)
</code>

^Argument^Description^Type^Required^
|entity|Container [[entity|entity]] to which the [[item|item]] will be added.|[[entity|Entity]]|Yes|
|item_id|ID of the [[item|item]] (as assigned in the [[item_editor|Item Editor]]).|[[string|String]]|Yes|
|count|How many of the [[item|item]] to add (defaults to 1).|[[number|Number]]|No|

====Example:====
<code bauxite>
add_item_to_container(self, "ITEM_0001", 1)
</code>
//Results:// One of ITEM_0001 is placed into the [[item_container|container]] [[entity|entity]] from which the [[script|script]] was triggered.

<WRAP center round tip 100%>
Use the **Add Item Container** function to place a new [[item|item]] into a chest or onto a table after the player has performed an action to build, generate, or "craft" the [[item|item]].
</WRAP>

----

<WRAP group>
<WRAP half column>
====Editor Node:====
{{:add_item_to_container_node.png?nolink|}}
</WRAP>

<WRAP half column>
====Visual Demo:====
{{:add_item_to_container_demo.gif?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation