User Tools

Site Tools


use_item

Differences

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

Link to this comparison view

Next revision
Previous revision
use_item [2024/02/05 01:37] – created justinuse_item [2024/02/22 21:12] (current) justin
Line 2: Line 2:
 ---- ----
 (WIP) (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:==== ====Signature:====
 <code python> <code python>
-use_item()+use_item(item_id, character)
 </code> </code>
  
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
-| | | | |+|item_id| |[[String]]|Yes| 
 +|character|Defaults to the main [[player character]].|[[Entity]]|No|
  
 ====Example:==== ====Example:====
 <code bauxite> <code bauxite>
-use_item();+
 </code> </code>
 //Results:// //Results://
use_item.1707125874.txt.gz · Last modified: 2024/02/05 01:37 by justin