Equip: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
imported>Heeheehee
m Typo-fixing?
imported>Bale
fixed typos and added formating
Line 26: Line 26:
}}|
}}|


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|equip_me}} 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.|
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|equip_me}} 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|equip_me}} is set to $item[none], the function aborts and you get a funky error because that makes no sense.  
*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.|


code1={{CodeSample|
code1={{CodeSample|
Line 42: Line 45:
cli_equiv=The CLI commands "equip" (and others, for specific slots) function similarly.|
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 specified and item is $item[none]?|I'm sure there are other edge-case I haven't thought of; if you do, please test and edit in.}}

Revision as of 09:33, 21 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 equip_me is set to $item[none], this function will unequip whatever is in slot where and return true.
  • If where is not specified and equip_me is set to $item[none], the function aborts and you get a funky error because that makes no sense.
  • 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.

    Code Sample

    Equips the Swashbuckling Getup carefully to ensure that the parot is in the second accessory slot.

equip($item[eyepatch]);
equip($item[swashbuckling pants]);
equip($slot[acc2], $item[stuffed shoulder parrot]);

CLI Equivalent

The CLI commands "equip" (and others, for specific slots) function similarly.

See Also

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


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