Difference between revisions of "Available amount"

From Kolmafia
Jump to navigation Jump to search
imported>Bale
(free pull note)
imported>Fredg1
(hangk is (supposedly) included when out of ronin, equipped items, closet and stash)
Line 15: Line 15:
 
}}|
 
}}|
  
function_description=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions. This includes free pulls, but does not include any other items in Hangk's Storage.|
+
function_description=Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions, including equipped items (for equipment). In Ronin, this includes free pulls, but does not include any other items in Hangk's Storage.
 +
If [[KoLmafia_Properties#Global_Variables|autoSatisfyWithCloset]] is set to true, this includes closet. If [[KoLmafia_Properties#Global_Variables|autoSatisfyWithStash]] is set to true, this includes clan stash.|
  
 
code1={{CodeSample|
 
code1={{CodeSample|

Revision as of 21:36, 24 November 2019

Function Syntax

int available_amount(item it )

  • it is the item to check

Returns the total number available of a given item in all inventory sections accessible to your character based on current restrictions, including equipped items (for equipment). In Ronin, this includes free pulls, but does not include any other items in Hangk's Storage. If autoSatisfyWithCloset is set to true, this includes closet. If autoSatisfyWithStash is set to true, this includes clan stash.

Code Sample

Enumerates total number of scrolls of ancient forbidden unspeakable evil.

int current_afue = available_amount($item[scroll of ancient forbidden unspeakable evil]);
// Calculate minimum of pens, paper and ink:
int make_afue = available_amount($item[disintegrating quill pen]);
make_afue = min(make_afue, available_amount($item[tattered scrap of paper]));
make_afue = min(make_afue, available_amount($item[inkwell]));
print("Currently possess "+ current_afue + " afue scrolls.");
print("Can make another "+ make_afue +" scrolls from parts.");

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.