Difference between revisions of "My adventures"

From Kolmafia
Jump to navigation Jump to search
imported>Metraxis
m (Grammar)
imported>Bale
m
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
[[int]] [[my_adventures()]]
+
{{
 +
#vardefine:name|my_adventures}}{{
 +
#vardefine:return_type|int}}{{
  
This function returns the logged-in character's current number of remaining adventures as an [[int]].  Use of this function is essential in any kind of goal-seeking loop, lest it run on forever trying to adventure with no way to do so. 
+
FunctionPage|
 +
name={{#var:name}}|
  
An example:
+
function1={{Function|
<code>
+
name={{#var:name}}|
while([[my_adventures()]] >= 4) {
+
aggregate={{#var:aggregate}}|
   if(use(1,$[[item]][dance card])) {
+
return_type={{#var:return_type}}|
    adventure(3,$[[location]][Haunted Gallery]);
+
return_also={{#var:return_also}}|
    adventure(3,$[[location]][Haunted Ballroom]);
+
}}|
   }
+
 
}</code>
+
function_description=Returns the logged-in character's number of adventures remaining.|
 +
 
 +
code1={{CodeSample|
 +
title=Code Samples|
 +
description=Using this function to spend all of your adventures farming the Castle:|
 +
code=
 +
<syntaxhighlight>
 +
adventure(my_adventures() , $location[giant's castle]);
 +
</syntaxhighlight>}}
 +
{{CodeSample|
 +
description=Checking to see if you have adventures left before doing something:|
 +
code=
 +
<syntaxhighlight>
 +
if (my_adventures() == 0) abort("You can't run this script without adventures.");
 +
</syntaxhighlight>}}
 +
{{CodeSample|
 +
description=Making sure you have enough adventures to perform a set of actions:|
 +
code=
 +
<syntaxhighlight>
 +
location farming_location = $location[giant's castle];
 +
while (my_adventures() >= 4) {
 +
   if (use(1 , $item[dance card])) {
 +
      adventure(3 , farming_location);
 +
      adventure(1 , $location[Haunted Ballroom]);
 +
   } else break;
 +
}
 +
</syntaxhighlight>}}|
 +
 
 +
see_also={{SeeAlso|adventure|use}}|
 +
special=When not logged in, this function returns 0.
 +
}}
 +
 
 +
[[Category:Your Character]]

Latest revision as of 21:32, 21 May 2010

Function Syntax

int my_adventures()

Returns the logged-in character's number of adventures remaining.

Code Samples

Using this function to spend all of your adventures farming the Castle:

adventure(my_adventures() , $location[giant's castle]);

Checking to see if you have adventures left before doing something:

if (my_adventures() == 0) abort("You can't run this script without adventures.");

Making sure you have enough adventures to perform a set of actions:

location farming_location = $location[giant's castle];
while (my_adventures() >= 4) {
   if (use(1 , $item[dance card])) {
      adventure(3 , farming_location);
      adventure(1 , $location[Haunted Ballroom]);
   } else break;
}

See Also

adventure() | use()

Special

When not logged in, this function returns 0.