Item amount: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>Bale
mNo edit summary
imported>Fredg1
m adding available_amount in See Also
Line 29: Line 29:
</syntaxhighlight>}}|
</syntaxhighlight>}}|


see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|shop_amount|stash_amount|storage_amount}}|
see_also={{SeeAlso|available_amount|closet_amount|display_amount|equipped_amount|shop_amount|stash_amount|storage_amount}}|
cli_equiv=The CLI command "inventory" functions similarly.|
cli_equiv=The CLI command "inventory" functions similarly.|
special=When not logged in, this function returns 0.
special=When not logged in, this function returns 0.

Revision as of 08:30, 19 November 2019

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

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

Special

When not logged in, this function returns 0.