Adventure: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle Created page with '{{#vardefine:name|adventure}} {{#vardefine:return_type|boolean}} {{FunctionPage| name={{#var:name}}| function_category=Adventuring| function1={{Function| name={{#var:name}}| ag…' |
imported>StDoodle No edit summary |
||
| Line 25: | Line 25: | ||
p1desc={{Pspan|int}} is the number of adventures to spend.| | p1desc={{Pspan|int}} is the number of adventures to spend.| | ||
p2desc={{Pspan|place}} is the adventuring location.| | p2desc={{Pspan|place}} is the adventuring location.| | ||
p3desc={{Pspan|filter}} is | p3desc={{Pspan|filter}} is a combat action filter (more info needed).| | ||
}}| | }}| | ||
function_description=This function runs adventures | function_description=This function runs the specified number of {{pspan|adventures}} at the given {{pspan|place}}, keeping up your current mood & obeying restore settings.</p> | ||
<p>If {{Pspan|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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> | |||
<p>Note that {{Pspan|adventures}} is the number of adventures to spend, and any "free" turns will not count towards this total.| | <p>Note that {{Pspan|adventures}} is the number of adventures to spend, and any "free" turns will not count towards this total.| | ||
Revision as of 01:37, 1 March 2010
Function Syntax
boolean adventure(int adventures ,location place ,string filter )
- int is the number of adventures to spend.
- place is the adventuring location.
- filter is a combat action filter (more info needed).
This function runs the specified number of adventures at the given place, keeping up your current mood & obeying restore settings.
If filter is omitted or assigned an empty string, this function will use your current CCS / battle action.
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.).
Note that adventures is the number of adventures to spend, and any "free" turns will not count towards this total.
Code Sample
Adventure 5 times at the Giant's Castle:
adventure(5 , $location[giant's castle]);CLI Equivalent
The CLI command "adv" works similarly.
See Also