add_item_condition

From Kolmafia
Revision as of 13:49, 23 December 2020 by Philmasterplus (talk | contribs) (Convert to Template:Function2 format)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function Syntax

void add_item_conditionint qty, item want )

  • qty: Desired quantity
  • want: Desired item

void add_item_conditionitem want, int qty )

Adds a number of the given item to the current auto-adventuring conditions.
  • want: Desired item
  • qty: Desired quantity

Adds qty of want to your current adventuring conditions. Auto-adventuring through KoLmafia or the adventure() function will stop if your current conditions are met.

Note that this function adds items in "+ mode" rather than the standard "total mode" done via the Adventuring pane of KoLmafia; ie it will add a condition to get qty additional items, rather than a condition to have qty total items in inventory.

The second form (item, quantity) was added in r20000.

Code Samples

Adventures at the Castle in the Sky Top Floor until you get the semi-rare or run out of adventures.

if ( get_property("semirareLocation") == "The Castle in the Clouds in the Sky (Top Floor)" )
{
   abort("Your last semi rare was Mick's IcyVapoHotness Inhaler, you can't get it again.");
}
add_item_condition( 1, $item[ Mick's IcyVapoHotness Inhaler ] );
int current = item_amount( $item[ Mick's IcyVapoHotness Inhaler ] );
adventure( my_adventures(), $location[ The Castle in the Clouds in the Sky (Top Floor) ] );
if ( item_amount( $item[ Mick's IcyVapoHotness Inhaler] ) > current )
{
   print("We found the Inhaler!", "green");
}
else
{
   print( "We failed to get the Inhaler :(", "red" );
}

CLI Equivalent

The CLI command "condition" offers similar functionality.

See Also

adventure() | is_goal() | remove_item_condition()