Item amount: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
No edit summary
imported>StDoodle
mNo edit summary
Line 1: Line 1:
{{#vardefine:name|item_amount}}
{{
{{#vardefine:return_type|int}}
#vardefine:name|item_amount}}{{
#vardefine:return_type|int}}{{


{{FunctionPage|
FunctionPage|
name={{#var:name}}|
name={{#var:name}}|
function_category=Item Management|
function_category=Item Management|

Revision as of 20:30, 8 March 2010

Function Syntax

int item_amount(item it )

  • it is the item to check for.

Returns the amount of an item you currently have in your inventory; does not include items in your Colossal Closet or Hagnk's storage.

Code Sample

This example function will return the total number of knob goblin firecrackers in your inventory, closet and Hagnk's.

int item_count() {
   item x = $item[knob goblin firecracker];
   int counter = item_amount( x ) + closet_amount( x ) + storage_amount( x );
   return counter;
}

CLI Equivalent

The CLI command "inventory" functions similarly.

See Also

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

Special

When not logged in, this function returns 0.