Have equipped: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>Slyz
dd code sample
Line 17: Line 17:


function_description=Returns true if you currently have the specified item {{pspan|check}} equipped, false if you do not. For familiar equipment, it only checks the familiar you currently have with you. Always returns false if {{pspan|check}} is not an item that can be equipped.|
function_description=Returns true if you currently have the specified item {{pspan|check}} equipped, false if you do not. For familiar equipment, it only checks the familiar you currently have with you. Always returns false if {{pspan|check}} is not an item that can be equipped.|
code1={{CodeSample|
title=Code Sample|
description=This example will check if you have the Pirate fledges equipped, and equip it if not.|
code=
<syntaxhighlight>
if ( !have_equipped($item[pirate fledges]) )
    equip( $slot[acc1], $item[pirate fledgesa] );
</syntaxhighlight>}}|


needscode=yes|
needscode=yes|

Revision as of 14:58, 31 March 2010

needs(code_samples);

Function Syntax

boolean have_equipped(item check )

  • check is the item to test for

Returns true if you currently have the specified item check equipped, false if you do not. For familiar equipment, it only checks the familiar you currently have with you. Always returns false if check is not an item that can be equipped.

Code Sample

This example will check if you have the Pirate fledges equipped, and equip it if not.

if ( !have_equipped($item[pirate fledges]) )
     equip( $slot[acc1], $item[pirate fledgesa] );

CLI Equivalent

The CLI commands "equip" and others function similarly, if the parameter "list" or no parameters are given.

See Also

can_equip() | equip()