Equip: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
imported>StDoodle
m moved Equip() to Equip
imported>StDoodle
No edit summary
Line 1: Line 1:
'''[[boolean]] equip([[slot]] slottype, item itemtype)'''<br>
{{#vardefine:name|equip}}
'''[[boolean]] equip(item itemtype)'''
{{#vardefine:return_type|boolean}}


{{FunctionPage|
name={{#var:name}}|
function_category=Equipment|


Will attempt to equip the item. If the slot is not provided it will attempt to place it in the 'normal' position for the item. (A hat will be placed in a hat slot, a weapon in the mainhand etc.)
function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter2={{Param|item|equip_me}}|
}}|


The return value indicates whether the item was succesfully equipped or not.
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|
}}|


Note: If no slot is selected, accessories will only be placed in empty slots.
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.|
<br><br>
 
<code>
needscode=yes|
equip($slot[acc3],$item[hardened slime belt]);
 
</code>
see_also={{SeeAlso|can_equip|equipped_amount|equipped_item|have_equipped}}|
<br>
cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.|
Attempts to equip the hardened slimt belt in the accessory 3 slot.
}}
<br><br>
{{RFI|What's up with the abort message when no slot is unspecified and item is $item[none]?}}
<code>
equip($item[rave whistle]);
</code>
<br>
Attempts to equip the rave whistle as the main weapon.

Revision as of 20:57, 5 March 2010



needs(code_samples);

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

can_equip() | equipped_amount() | equipped_item() | have_equipped()


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]?

Retrieved from "https://wiki.kolmafia.us/index.php?title=Equip&oldid=3227"