Adv1: Difference between revisions
imported>Bale mNo edit summary |
imported>Bale Document the undocumented macro feature! |
||
| Line 16: | Line 16: | ||
p1desc={{Pspan|place}} is the adventuring location.| | p1desc={{Pspan|place}} is the adventuring location.| | ||
p2desc={{Pspan|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.| | p2desc={{Pspan|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.| | ||
p3desc={{Pspan|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.}}| | p3desc={{Pspan|filterFunc}} is a macro or 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.}}| | ||
function_description=This will adventure exactly once in the specified {{pspan|place}} (even if it took no turns), although it will follow chained choice adventures for as long as you have preset options.</p> | function_description=This will adventure exactly once in the specified {{pspan|place}} (even if it took no turns), although it will follow chained choice adventures for as long as you have preset options.</p> | ||
<p>If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro with semicolons replaced by line breaks.</p> | |||
<p>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.).| | <p>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.).| | ||
Revision as of 01:51, 25 October 2010
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 a macro or 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.
If filter contains a semicolon it will use filter as a macro with semicolons replaced by line breaks.
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
None - "adv" will always try adventuring again if an adventure took no turns.