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.

======Give Item======
----

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:====
<code python>
give_item(item_id, count, character)
</code>

^Argument^Description^Type^Required^
|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|
|character|[[Character]] the [[item]] will be given to (defaults to main [[player character]]).|[[Entity]]|No|

^Return Value^Description^Type^
|Number Given|Returns the actual number of [[item|items]] that were given to the player. This could be less than the count supplied to the function, for example if the player's [[inventory]] becomes full.|[[Number]]|

====Example:====
<code bauxite>
give_item("ITEM_0007", 5);
</code>
//Results:// Five of ITEM_0007 are placed into the player's [[inventory]].

<WRAP center round tip 100%>
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 group>
<WRAP half column>
====Editor Node:====
{{:wiki:give_item_node.png?nolink|}}
</WRAP>

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

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation