Difference between revisions of "Storage amount"

From Kolmafia
Jump to navigation Jump to search
imported>PhilmASTErpLus
(Added code sample and removed needscode=yes.)
imported>Bale
(free pull info)
Line 15: Line 15:
 
}}|
 
}}|
  
function_description=Returns the amount of the given item that are in storage at Hagnk's.|
+
function_description=Returns the amount of the given item that are in storage at Hagnk's. This will return 0 if the item is a free pull.|
  
 
code1={{CodeSample|
 
code1={{CodeSample|
Line 40: Line 40:
  
 
see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|item_amount|shop_amount|stash_amount}}|
 
see_also={{SeeAlso|closet_amount|display_amount|equipped_amount|item_amount|shop_amount|stash_amount}}|
 +
more_info=Information on handling free pulls is at [[Tips, Tricks and Workarounds#Free Pulls|Tips, Tricks and Workarounds]].|
 
}}
 
}}
  
 
[[Category:Item Management]]
 
[[Category:Item Management]]

Revision as of 06:29, 25 September 2010

Function Syntax

int storage_amount(item it )

  • it is the item to check

Returns the amount of the given item that are in storage at Hagnk's. This will return 0 if the item is a free pull.

Code Sample

The following code will check a pull list loaded from a text file.

int day = 2;
int [int, item] static_pulls; //Items that are always included in a pull list.
file_to_map( "static_pulls.txt" , static_pulls );

//Validate your pull list before you begin the day
foreach it, req_num in static_pulls[ day ]
{
   if ( storage_amount( it ) < req_num )
      print( "Uh-oh! You don't have enough of " + it + " to pull." , "red" );
   else
      print( "You have enough " + it );
}

Note that take_storage() returns a boolean value indicating whether an attempt at pulling was successful.

See Also

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

More Information

Information on handling free pulls is at Tips, Tricks and Workarounds.