Difference between revisions of "Use"
Jump to navigation
Jump to search
imported>StDoodle m |
imported>Bale |
||
| Line 24: | Line 24: | ||
see_also={{SeeAlso|drink|eat|equip}}| | see_also={{SeeAlso|drink|eat|equip}}| | ||
cli_equiv=The CLI command "use" functions similarly.| | cli_equiv=The CLI command "use" functions similarly.| | ||
| + | more_info=If {{pspan|qty}} is 0 or negative, no item will be used and the function will return true.| | ||
}} | }} | ||
Revision as of 11:16, 11 May 2010
needs(code_samples);
Function Syntax
boolean use(int qty ,item it )
- qty is the quantity to use
- it is the item to use
Attempts to use qty amount of item it. Returns true if the item is used or false if it fails to do so. Note that food must be "used" via eat() & drinks via drink(); attempting to use this function will result in an error message and a return value of false. Using this function for equipment will function the same as equip() would without the optional slot parameter. If this function is called with a non-usable item, a message saying so will print to the CLI and the function will return true.
CLI Equivalent
The CLI command "use" functions similarly.
See Also
More Information
If qty is 0 or negative, no item will be used and the function will return true.