Adv1

From Kolmafia
Revision as of 11:20, 3 March 2010 by imported>Bale (Created page with '{{#vardefine:name|adv1}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Adventuring| function1={{Function| name={{#var:name}}| aggrega…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search



Function Syntax

boolean adv1(location place ,int turnsUsed ,string filterFunc )

  • place is the adventuring location.
  • turnsUsed overrides the normal number of adventures that are expected to be consumed at this location, or -1 can be passed to use the default. Specifically, 0 will prevent any counters from triggering - of course, if an adventure actually is consumed, any counters that you kept from triggering will be lost.
  • filterFunc is the name of a combat filter function defined elsewhere in your script, with the same behavior as in the 3-paramater version of adventure(). An empty string can be passed to use your battle action or CCS as normal.

This will adventure exactly once in the specified place (even if it took no turns), although it will follow chained choice adventures for as long as you have preset options.

This function does not have to make use of its return value, but if you wish to do so, it will return true if all adventures were used, and false if it is unable to do so for any reason (not enough adventures, location unavailable, etc.).

Code Sample

Adventures 1 time at the Slime Tube. If an adventure takes no turns, possibly because the Gall Bladder was already squeezed, that adventure will still count. Counters will trigger as normal.

adv1($location[slime tube], -1, "");

CLI Equivalent

The CLI command "adv" works similarly.

See Also

adventure()