User Tools

Site Tools


give_item

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
give_item [2018/03/16 09:45]
justin
give_item [2020/02/19 11:29] (current)
justin
Line 2: Line 2:
 ---- ----
  
-Gives the specified item to the player. The name of the item is case-sensitive and should match the name as defined ​in the [[item_editor|Item Editor]]. The item will be placed into the first open slot of the player'​s inventory.+Gives one or more of the specified ​[[item]] to the player. The ID of the [[item]] is case-sensitive and should match the name assigned to it in the [[item_editor|Item Editor]]. The [[item|item(s)]] ​will be placed into the first open slot(s) of the player'​s ​[[inventory]].
  
 ====Signature:​==== ====Signature:​====
 <code python> <code python>
-give_item(item_name)+give_item(item_id, count)
 </​code>​ </​code>​
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-|item_name|Name of the item (as defined in the [[Item Editor]]).|[[String]]|Yes|+|item_id|ID of the [[item]] (as defined in the [[Item Editor]]).|[[String]]|Yes
 +|count|How many of the [[item]] to give to the player (defaults to 1).|[[Number]]|No|
  
 ====Example:​==== ====Example:​====
-<​code ​python+<​code ​bauxite
-give_item("​Blue Gem")+give_item("​ITEM_0007", 5)
 </​code>​ </​code>​
-//​Results:// ​A Blue Gem is placed into the player'​s inventory.+//​Results:// ​Five of ITEM_0007 are placed into the player'​s ​[[inventory]].
  
 <WRAP center round tip 100%> <WRAP center round tip 100%>
-Use the **Give Item** function to reward the player for completing a quest or as a way of collecting items from treasure chests and other containers.+Use the **Give Item** function to reward the player for completing a quest or as a way of collecting ​[[item|items]] from treasure chests and other [[item_container|containers]].
 </​WRAP>​ </​WRAP>​
  
give_item.1521218705.txt.gz · Last modified: 2018/03/16 09:45 by justin