Kolmafia - User contributions [en]

Adventure

2011-06-20T19:13:29Z

Stannius: another minor change to sample code

{{
#vardefine:name|adventure}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|adventures}}|
parameter2={{Param|location|place}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|adventures}}|
parameter2={{Param|location|place}}|
parameter3={{Param|string|filter}}|
p1desc={{Pspan|int}} is the number of adventures to spend.|
p2desc={{Pspan|place}} is the adventuring location.|
p3desc={{Pspan|filter}} is a combat action filter. If {{Pspan|filter}} contains a semicolon it is interpreted as a macro, otherwise this is the name of a top-level function which modifies the current CCS. A combat filter function takes the parameters of a consult script, but returns lines like a CCS, not like a consult script. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=This function runs the specified number of {{pspan|adventures}} at the given {{pspan|place}}, keeping up your current mood & obeying restore settings.
If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro.
If {{Pspan|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.
This function returns true if the specified number of adventures were used, and false if not. Possible reasons for returning false include being out of adventures, a location being unavailable, conditions being statisfied ''before'' {{Pspan|adventures}} were used up and all [[auto-stops]], including encountering a demon name or hobo glyph.
Note that {{Pspan|adventures}} is the number of adventures to spend in the specified location {{pspan|place}}. Any "free" turns (choiceadventures that don't consume an adventure, usually) or adventures spend in other locations (by a counterScript or a betweenBattleScript for example) will not count towards this total.
As with auto-adventuring from the Adventure tab, adventure() checks against goals set via [[add_item_condition|add_item_condition()]] or via other methods of specifying goals in KoLmafia, and will auto-stop if all goals were satisfied.|

code1={{CodeSample|
title=Code Sample|
description=Adventure 5 times at the Giant's Castle:|
code=
<syntaxhighlight>
adventure(5 , $location[giant's castle]);
</syntaxhighlight>}}
{{CodeSample|
title=Example of a Combat Filter|
description=This uses the combat filter to automatically olfact Goth Giants while adventuring.|
code=
<syntaxhighlight>

string olfact_goth(int round, string opp, string text) {
if(opp != "Goth Giant")
return get_ccs_action(round);
if(round == 1 && have_effect($effect[On the Trail]) < 1)
return "skill transcendent olfaction";
return get_ccs_action(round - 1);
}

adventure(5 , $location[giant castle], "olfact_goth");
</syntaxhighlight>}}
{{CodeSample|
description=Uses a combat filter to ensure that all sewer monsters are being cleeshed while you try to make your way to Hobopolis.|
code=
<syntaxhighlight>
string combat_cleesh(int round, string opp, string text) {
if (opp == $monster[frog].to_string() || opp == $monster[newt].to_string()
|| opp == $monster[salamander].to_string()) {
return "attack";
}
return "skill CLEESH";
}

adventure(1, $location[a maze of sewer tunnels], "combat_cleesh");
</syntaxhighlight>}}
{{CodeSample|
description=This makes use of the combat filter to ensure that salve is being used.|
code=
<syntaxhighlight>
// Adds salve to beginning of combat if it doesn't already exist in the CCS.
// Otherwise it simply returns the current CCS.
string insert_salve(int round, string opp, string text) {
boolean salve = false;
for i from 1 to 30
if(get_ccs_action(round) == "skill saucy salve")
salve = true;
if(salve)
return get_ccs_action(round);
else {
if(round == 1)
return "skill saucy salve";
if(round > 1)
round = round - 1; // compensate for insertion
return get_ccs_action(round); // for the rest of the combat, executes your existing ccs
}
}

adventure(5 , $location[giant castle], "insert_salve");
</syntaxhighlight>}}|

see_also={{SeeAlso|adv1}}|
cli_equiv=The CLI command "adv" works similarly.|
special=This function will return false if KoLmafia conditions are met before completing the specified number of turns.Also, if the filter function is not top-level code, it will not be found, since it's being called outside of ASH. As a result, it will return "void", which may result in the use of $item[ovoid leather thing].
}}

[[Category:Adventuring]]

Adventure

2011-06-20T19:12:26Z

Stannius: missing semicolon in example code

{{
#vardefine:name|adventure}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|adventures}}|
parameter2={{Param|location|place}}|
}}|

function2={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|int|adventures}}|
parameter2={{Param|location|place}}|
parameter3={{Param|string|filter}}|
p1desc={{Pspan|int}} is the number of adventures to spend.|
p2desc={{Pspan|place}} is the adventuring location.|
p3desc={{Pspan|filter}} is a combat action filter. If {{Pspan|filter}} contains a semicolon it is interpreted as a macro, otherwise this is the name of a top-level function which modifies the current CCS. A combat filter function takes the parameters of a consult script, but returns lines like a CCS, not like a consult script. Essentially, this allows the scripter to put a CCS or macro into a script.|
}}|

function_description=This function runs the specified number of {{pspan|adventures}} at the given {{pspan|place}}, keeping up your current mood & obeying restore settings.
If {{Pspan|filter}} contains a semicolon it will use {{Pspan|filter}} as a macro.
If {{Pspan|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.
This function returns true if the specified number of adventures were used, and false if not. Possible reasons for returning false include being out of adventures, a location being unavailable, conditions being statisfied ''before'' {{Pspan|adventures}} were used up and all [[auto-stops]], including encountering a demon name or hobo glyph.
Note that {{Pspan|adventures}} is the number of adventures to spend in the specified location {{pspan|place}}. Any "free" turns (choiceadventures that don't consume an adventure, usually) or adventures spend in other locations (by a counterScript or a betweenBattleScript for example) will not count towards this total.
As with auto-adventuring from the Adventure tab, adventure() checks against goals set via [[add_item_condition|add_item_condition()]] or via other methods of specifying goals in KoLmafia, and will auto-stop if all goals were satisfied.|

code1={{CodeSample|
title=Code Sample|
description=Adventure 5 times at the Giant's Castle:|
code=
<syntaxhighlight>
adventure(5 , $location[giant's castle]);
</syntaxhighlight>}}
{{CodeSample|
title=Example of a Combat Filter|
description=This uses the combat filter to automatically olfact Goth Giants while adventuring.|
code=
<syntaxhighlight>

string olfact_goth(int round, string opp, string text) {
if(opp != "Goth Giant")
return get_ccs_action(round);
if(round == 1 && have_effect($effect[On the Trail]) < 1)
return "skill transcendent olfaction";
else
return get_ccs_action(round - 1);
}

adventure(5 , $location[giant castle], "olfact_goth");
</syntaxhighlight>}}
{{CodeSample|
description=Uses a combat filter to ensure that all sewer monsters are being cleeshed while you try to make your way to Hobopolis.|
code=
<syntaxhighlight>
string combat_cleesh(int round, string opp, string text) {
if (opp == $monster[frog].to_string() || opp == $monster[newt].to_string()
|| opp == $monster[salamander].to_string()) {
return "attack";
}
return "skill CLEESH";
}

adventure(1, $location[a maze of sewer tunnels], "combat_cleesh");
</syntaxhighlight>}}
{{CodeSample|
description=This makes use of the combat filter to ensure that salve is being used.|
code=
<syntaxhighlight>
// Adds salve to beginning of combat if it doesn't already exist in the CCS.
// Otherwise it simply returns the current CCS.
string insert_salve(int round, string opp, string text) {
boolean salve = false;
for i from 1 to 30
if(get_ccs_action(round) == "skill saucy salve")
salve = true;
if(salve)
return get_ccs_action(round);
else {
if(round == 1)
return "skill saucy salve";
if(round > 1)
round = round - 1; // compensate for insertion
return get_ccs_action(round); // for the rest of the combat, executes your existing ccs
}
}

adventure(5 , $location[giant castle], "insert_salve");
</syntaxhighlight>}}|

see_also={{SeeAlso|adv1}}|
cli_equiv=The CLI command "adv" works similarly.|
special=This function will return false if KoLmafia conditions are met before completing the specified number of turns.Also, if the filter function is not top-level code, it will not be found, since it's being called outside of ASH. As a result, it will return "void", which may result in the use of $item[ovoid leather thing].
}}

[[Category:Adventuring]]