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 [2019/12/23 22:04]
justin
add_item_to_container [2020/06/07 17:19] (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 player'​s inventory.+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:​==== ====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|entity]] ​to which the [[item|item]] ​will be added.|[[entity|Entity]]|Yes| 
-|item_id|ID of the item (as assigned in the [[Item Editor]]).|[[String]]|Yes| +|item_id|ID of the [[item|item]] ​(as assigned in the [[item_editor|Item Editor]]).|[[string|String]]|Yes| 
-|count|Number ​of the item to add (defaults to 1).|[[Decimal]]|No|+|count|How many of the [[item|item]] ​to add (defaults to 1).|[[number|Number]]|No|
  
 ====Example:​==== ====Example:​====
-<​code ​python+<​code ​bauxite
-add_item_to_container("​wooden_chest"​, "​ITEM_0001", ​2)+add_item_to_container(self, "​ITEM_0001", ​1)
 </​code>​ </​code>​
-//​Results:// ​Two of ITEM_0001 ​are placed into the "​wooden_chest" ​container entity.+//​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%> <WRAP center round tip 100%>
-Use the **Add Item Container** function to ...+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>​
  
Line 29: Line 29:
 <WRAP half column> <WRAP half column>
 ====Editor Node:==== ====Editor Node:====
-{{:wiki:​give_item_node.png?​nolink|}}+{{:add_item_to_container_node.png?​nolink|}}
 </​WRAP>​ </​WRAP>​
  
 <WRAP half column> <WRAP half column>
 ====Visual Demo:==== ====Visual Demo:====
-{{:wiki:​give_item_demo.gif?​nolink|}}+{{:add_item_to_container_demo.gif?​nolink|}}
 </​WRAP>​ </​WRAP>​
 </​WRAP>​ </​WRAP>​
add_item_to_container.1577167497.txt.gz · Last modified: 2019/12/23 22:04 by justin