RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
use_item

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
use_item [2024/02/05 16:15] – justinuse_item [2024/02/05 16:48] – justin
Line 3: Line 3:
 (WIP) (WIP)
  
-Uses/consumes the specified [[item]]. +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:====
Line 12: Line 12:
 ^Argument^Description^Type^Required^ ^Argument^Description^Type^Required^
 |item_id| |[[String]]|Yes| |item_id| |[[String]]|Yes|
-|character|Defaults to "player" (i.e. the main [[player character]]).|[[Entity]]|No|+|character|Defaults to the main [[player character]].|[[Entity]]|No|
  
 ====Example:==== ====Example:====
use_item.txt · Last modified: 2024/02/22 21:12 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki