Autosell: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle m moved Autosell() to Autosell |
imported>StDoodle No edit summary |
||
Line 1: | Line 1: | ||
{{#vardefine:name|autosell}} | |||
{{#vardefine:return_type|boolean}} | |||
{{FunctionPage| | |||
name={{#var:name}}| | |||
function_category=Item Management| | |||
function1={{Function| | |||
# | name={{#var:name}}| | ||
aggregate={{#var:aggregate}}| | |||
return_type={{#var:return_type}}| | |||
return_also={{#var:return_also}}| | |||
parameter1={{Param|int|qty}}| | |||
parameter2={{Param|item|it}}| | |||
p1desc={{pspan|qty}} is the quantity to sell| | |||
p2desc={{pspan|it}} is the item to sell| | |||
}}| | |||
function_description=Attempts to autosell {{pspan|qty}} of {{pspan|it}}. Returns true if all items are sold as specified, or as many as possible, and false.</p> | |||
<p>Note that specifying a higher {{pspan|qty}} than you have of an item, or an item that cannot be autosold, will still return true as the function has done as much as it could.| | |||
} | needscode=yes| | ||
cli_equiv=The CLI commands "sell" and "autosell" function similarly.| | |||
}} |
Revision as of 00:47, 5 March 2010
needs(code_samples);
Function Syntax
boolean autosell(int qty ,item it )
- qty is the quantity to sell
- it is the item to sell
Attempts to autosell qty of it. Returns true if all items are sold as specified, or as many as possible, and false.
Note that specifying a higher qty than you have of an item, or an item that cannot be autosold, will still return true as the function has done as much as it could.
CLI Equivalent
The CLI commands "sell" and "autosell" function similarly.