Difference between revisions of "Equip"
imported>StDoodle |
imported>StDoodle |
||
| Line 1: | Line 1: | ||
| − | + | {{#vardefine:name|equip}} | |
| − | + | {{#vardefine:return_type|boolean}} | |
| + | {{FunctionPage| | ||
| + | name={{#var:name}}| | ||
| + | function_category=Equipment| | ||
| − | + | function1={{Function| | |
| + | name={{#var:name}}| | ||
| + | aggregate={{#var:aggregate}}| | ||
| + | return_type={{#var:return_type}}| | ||
| + | return_also={{#var:return_also}}| | ||
| + | parameter2={{Param|item|equip_me}}| | ||
| + | }}| | ||
| − | + | function2={{Function| | |
| + | name={{#var:name}}| | ||
| + | aggregate={{#var:aggregate}}| | ||
| + | return_type={{#var:return_type}}| | ||
| + | return_also={{#var:return_also}}| | ||
| + | parameter1={{Param|slot|where}}| | ||
| + | parameter2={{Param|item|equip_me}}| | ||
| + | p1desc={{Pspan|where}} is the slot to place the item in (optional)| | ||
| + | p2desc={{Pspan|equip_me}} is the item to equip| | ||
| + | }}| | ||
| − | + | function_description=Attempts to equip the item {{pspan|equip_me}} in the slot {{pspan|where}} if specified, and returns true if the operation was successful, and false if it was not. If parameter {{pspan|where}} is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If {{pspan|where}} is specified and {{pspan|where}} is set to $item[none], this function will unequip whatever is in slot {{pspan|where}} and return true. If {{pspan|where}} is not specified and {{pspan|where}} is set to $item[none], the function aborts and you get a funky error. If you cannot equip {{pspan|equip_me}}, or {{pspan|where}} is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.| | |
| − | + | ||
| − | + | needscode=yes| | |
| − | + | ||
| − | + | see_also={{SeeAlso|can_equip|equipped_amount|equipped_item|have_equipped}}| | |
| − | + | cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.| | |
| − | + | }} | |
| − | + | {{RFI|What's up with the abort message when no slot is unspecified and item is $item[none]?}} | |
| − | |||
| − | equip($item[ | ||
| − | |||
| − | |||
| − | |||
Revision as of 20:57, 5 March 2010
Function Syntax
boolean equip(,item equip_me )
boolean equip(slot where ,item equip_me )
- where is the slot to place the item in (optional)
- equip_me is the item to equip
Attempts to equip the item equip_me in the slot where if specified, and returns true if the operation was successful, and false if it was not. If parameter where is not specified, it defaults to the "standard" place for such an item (main-hand for 1-handed weapons, first open slot for accessories or acc1 if no slots are open). If where is specified and where is set to $item[none], this function will unequip whatever is in slot where and return true. If where is not specified and where is set to $item[none], the function aborts and you get a funky error. If you cannot equip equip_me, or where is supplied and the item cannot be used in that slot, you will be given an error message and this function will return false.
CLI Equivalent
The CLI commands "equip" (and others, for specific slots) function similarly.
See Also
Attention KoLmafia Experts!
We need your help; some details of this function's operation are unknown or unclear.
The following specific question has been raised:
- What's up with the abort message when no slot is unspecified and item is $item[none]?