User Tools

Site Tools


add_item_to_container

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
add_item_to_container [2020/01/25 10:19]
justin
add_item_to_container [2020/02/19 11:29] (current)
justin
Line 2: Line 2:
 ---- ----
  
-Adds one or more of the specified item to an item container. The ID of the item is case-sensitive and should match the ID assigned to it in the [[item_editor|Item Editor]] (e.g. "​ITEM_0001"​). The item will be placed into the first open slot of the container.+Adds one or more of the specified ​[[item]] to an [[item_container|item container]]. The ID of the [[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:​==== ====Signature:​====
Line 10: Line 10:
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|entity|Container entity to which the item will be added.|[[Entity]]|Yes| +|entity|Container ​[[entity]] to which the [[item]] will be added.|[[Entity]]|Yes| 
-|item_id|ID of the item (as assigned in the [[Item Editor]]).|[[String]]|Yes| +|item_id|ID of the [[item]] (as assigned in the [[Item Editor]]).|[[String]]|Yes| 
-|count|Number ​of the item to add (defaults to 1).|[[Decimal]]|No|+|count|How many of the [[item]] to add (defaults to 1).|[[Number]]|No|
  
 ====Example:​==== ====Example:​====
-<​code ​lua>+<​code ​bauxite>
 add_item_to_container(self,​ "​ITEM_0001",​ 1) add_item_to_container(self,​ "​ITEM_0001",​ 1)
 </​code>​ </​code>​
-//​Results://​ One of ITEM_0001 is placed into the container entity from which the script was triggered.+//​Results://​ One of ITEM_0001 is placed into the [[item_container|container]] [[entity]] from which the [[script]] was triggered.
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Add Item Container** function to place a new item into a chest or onto a table after the player has performed an action to build, generate, or "​craft"​ the item.+Use the **Add Item Container** function to place a new [[item]] into a chest or onto a table after the player has performed an action to build, generate, or "​craft"​ the [[item]].
 </​WRAP>​ </​WRAP>​
  
add_item_to_container.1579976392.txt.gz · Last modified: 2020/01/25 10:19 by justin