Difference between revisions of "Retrieve item"
Jump to navigation
Jump to search
imported>StDoodle m (moved Retrieve item() to Retrieve item) |
imported>StDoodle |
||
| Line 1: | Line 1: | ||
| − | {{ | + | {{#vardefine:name|retrieve_item}} |
| − | + | {{#vardefine:return_type|boolean}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | boolean | ||
| − | |||
| − | + | {{FunctionPage| | |
| − | + | name={{#var:name}}| | |
| − | + | function_category=Item Management| | |
| − | + | second_category=Adventuring| | |
| − | |||
| − | |||
| − | |||
| − | + | 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|get}}| | ||
| + | p1desc={{Pspan|qty}} is the quantity to acquire| | ||
| + | p2desc={{Pspan|get}} is the item to acquire| | ||
| + | }}| | ||
| − | }| | + | function_description=Uses KoLmafia's internal logic to gather the items in the least destructive manner. Returns true if items are acquired as specified and false if not.| |
| + | |||
| + | needscode=yes| | ||
| + | |||
| + | see_also={{SeeAlso|buy}}| | ||
| + | cli_equiv=The CLI command "acquire" works similarly.| | ||
| + | special=Unlike a few other ASH commands, retrieve_item() will still return false on attempts to acquire items that are not possible to get (such as a sparkly engagement ring). | ||
}} | }} | ||
| + | {{RFI|What's the order-of-operations (create, NPC, mall)?|Are there exceptions to the info listed under Special?}} | ||
Revision as of 15:10, 5 March 2010
needs(code_samples);
Function Syntax
boolean retrieve_item(int qty ,item get )
- qty is the quantity to acquire
- get is the item to acquire
Uses KoLmafia's internal logic to gather the items in the least destructive manner. Returns true if items are acquired as specified and false if not.
CLI Equivalent
The CLI command "acquire" works similarly.
See Also
Special
Unlike a few other ASH commands, retrieve_item() will still return false on attempts to acquire items that are not possible to get (such as a sparkly engagement ring).
Attention KoLmafia Experts!
We need your help; some details of this function's operation are unknown or unclear.
The following specific questions have been raised:
- What's the order-of-operations (create, NPC, mall)?
- Are there exceptions to the info listed under Special?