Difference between revisions of "Can equip"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
m
imported>Bale
(added code sample)
Line 18: Line 18:
 
function_description=Returns true if, based on your current stats, you are capable of equipping {{pspan|check_me}} on your character, false if you cannot. Note that this function doesn't check for whether or not you actually have the item; just whether you're capable of equipping it. |
 
function_description=Returns true if, based on your current stats, you are capable of equipping {{pspan|check_me}} on your character, false if you cannot. Note that this function doesn't check for whether or not you actually have the item; just whether you're capable of equipping it. |
  
needscode=yes|
+
code1={{CodeSample|
 +
title=Code Sample|
 +
description=Check to see if the character can equip a Hippo Poncho.|
 +
code=
 +
<syntaxhighlight>
 +
if(!have_skill($skill[torso awaregness]))
 +
  print("Cannot equip a shirt if you don't know how to find your own torso!");
 +
if(can_equip($item[hippo poncho]))
 +
  print("You're sexy enough to wear a hippo poncho.", "green");
 +
else print("You're not sexy enough to wear a hippo poncho.", "red");
 +
</syntaxhighlight>
 +
}}|
  
 
see_also={{SeeAlso|have_equipped}}|
 
see_also={{SeeAlso|have_equipped}}|

Revision as of 09:26, 10 March 2010

Function Syntax

boolean can_equip(item check_me )

  • check_me is the item to check

Returns true if, based on your current stats, you are capable of equipping check_me on your character, false if you cannot. Note that this function doesn't check for whether or not you actually have the item; just whether you're capable of equipping it.

Code Sample

Check to see if the character can equip a Hippo Poncho.

if(!have_skill($skill[torso awaregness]))
   print("Cannot equip a shirt if you don't know how to find your own torso!");
if(can_equip($item[hippo poncho]))
   print("You're sexy enough to wear a hippo poncho.", "green");
else print("You're not sexy enough to wear a hippo poncho.", "red");

See Also

have_equipped()

Special

Note that this only checks for stat requirements to equip an item, so, for example, checking for a chefstaff will return true if you meet the stat requirements to equip it, even if you don't have Spirit of Rigatoni or a sauce glove. (Similarly, Torso Awareness isn't checked for shirts.)


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:

  • Is my note regarding "stat requirements only" correct, or are some other situations checked for?