Difference between revisions of "Can equip"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{{#vardefine:name|can_equip}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=| function1={{Function| name={{#var:name}}| aggregate={{#…')
 
imported>StDoodle
Line 11: Line 11:
 
return_type={{#var:return_type}}|
 
return_type={{#var:return_type}}|
 
return_also={{#var:return_also}}|
 
return_also={{#var:return_also}}|
parameter1={{Param|DATATYPE|SHORT_DESC}}|
+
parameter1={{Param|item|check_me}}|
p1desc={{Pspan|}}|
+
p1desc={{Pspan|check_me}} is the item to check|
 
}}|
 
}}|
  
function_description=|
+
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|
 
needscode=yes|
  
see_also={{SeeAlso|}}|
+
see_also={{SeeAlso|have_equipped}}|
cli_equiv=The CLI command |
+
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.|
more_info= |
 
special= |
 
 
}}
 
}}
 +
{{RFI|Is my note regarding "stat requirements only" correct, or are some other situations checked for?}}

Revision as of 15:55, 6 March 2010



needs(code_samples);

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.

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.


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?