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.

======Use Item======
----
(WIP)

Uses/consumes the specified [[item]]. If the [[character]] isn't specified, the [[item]] will be used by the main [[player character]]. Note that the [[item]] must be configured as "Usable/Consumable" in the [[Item Editor]] and the [[character]] must first have the [[item]] in their [[inventory]] in order for this function to work.

====Signature:====
<code python>
use_item(item_id, character)
</code>

^Argument^Description^Type^Required^
|item_id| |[[String]]|Yes|
|character|Defaults to the main [[player character]].|[[Entity]]|No|

====Example:====
<code bauxite>

</code>
//Results://

<WRAP center round tip 100%>
Use the **Use Item** function to...
</WRAP>

----

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

<WRAP half column>
</WRAP>
</WRAP>

~~NOTOC~~

RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation