Equipped amount: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Heeheehee
m Made the code sample more accurate. And documented!
add boolean
 
(2 intermediate revisions by 2 users not shown)
Line 5: Line 5:
FunctionPage|
FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Item Management|
second_category=Equipment|


function1={{Function|
function1={{Function|
Line 14: Line 12:
return_also={{#var:return_also}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
parameter1={{Param|item|it}}|
}}|
function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|item|it}}|
parameter2={{Param|boolean|includeAllFamiliars}}|
p1desc={{Pspan|it}} is the item that will be checked for among your worn gear.|
p1desc={{Pspan|it}} is the item that will be checked for among your worn gear.|
p2desc={{Pspan|includeAllFamiliars}} is whether you want to check the familiars in your terrarium in addition to your current familiar.|
}}|
}}|


Line 32: Line 40:
see_also={{SeeAlso|closet_amount|display_amount|item_amount|shop_amount|stash_amount|storage_amount}}|
see_also={{SeeAlso|closet_amount|display_amount|item_amount|shop_amount|stash_amount|storage_amount}}|
}}
}}
[[Category:Item Management]][[Category:Equipment]]

Latest revision as of 08:56, 24 March 2023

Function Syntax

int equipped_amount(item it )

int equipped_amount(item it ,boolean includeAllFamiliars )

  • it is the item that will be checked for among your worn gear.
  • includeAllFamiliars is whether you want to check the familiars in your terrarium in addition to your current familiar.

Returns the amount of a given item currently equipped on your character.

Code Sample

Checks if you're safe to chat.

if (equipped_amount($item[sword behind inappropriate prepositions]) == 1 && have_effect($effect[Wanged]) == 0)
// Sword doesn't fire if you have this particular effect.
   abort("You aren't safe to chat!");

See Also

closet_amount() | display_amount() | item_amount() | shop_amount() | stash_amount() | storage_amount()