Adventure - Revision history

Fredg1 at 05:56, 22 November 2019

2019-11-22T05:56:56Z

← Older revision		Revision as of 05:56, 22 November 2019
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 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.\|		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.\|
	}}\|		}}\|

Bale: see also run_combat()

2016-12-03T21:13:36Z

Bale: r17447

2016-11-29T22:43:31Z

r17447

← Older revision		Revision as of 22:43, 29 November 2016
Line 48:		Line 48:
	<syntaxhighlight>		<syntaxhighlight>

	string olfact_goth(int round, ~~string~~ opp, string text) {		string olfact_goth(int round, monster opp, string text) {
	if(opp != "Goth Giant")		if(opp != $monster[Goth Giant])
	return get_ccs_action(round);		return get_ccs_action(round);
	if(round == 1 && have_effect($effect[On the Trail]) < 1)		if(round == 1 && have_effect($effect[On the Trail]) < 1)
Line 62:		Line 62:
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	string combat_cleesh(int round, ~~string~~ opp, string text) {		string combat_cleesh(int round, monster opp, string text) {
	if (opp == $monster[frog]~~.to_string()~~ \|\| opp == $monster[newt]~~.to_string()~~		if (opp == $monster[frog] \|\| opp == $monster[newt]
	\|\| opp == $monster[salamander]~~.to_string()~~) {		\|\| opp == $monster[salamander]) {
	return "attack";		return "attack";
	}		}
Line 78:		Line 78:
	// Adds salve to beginning of combat if it doesn't already exist in the CCS.		// Adds salve to beginning of combat if it doesn't already exist in the CCS.
	// Otherwise it simply returns the current CCS.		// Otherwise it simply returns the current CCS.
	string insert_salve(int round, ~~string~~ opp, string text) {		string insert_salve(int round, monster opp, string text) {
	boolean salve = false;		boolean salve = false;
	for i from 1 to 30		for i from 1 to 30

Stannius: another minor change to sample code

2011-06-20T19:13:29Z

another minor change to sample code

← Older revision		Revision as of 19:13, 20 June 2011
Line 53:		Line 53:
	if(round == 1 && have_effect($effect[On the Trail]) < 1)		if(round == 1 && have_effect($effect[On the Trail]) < 1)
	return "skill transcendent olfaction";		return "skill transcendent olfaction";
	~~else~~		return get_ccs_action(round - 1);
	return get_ccs_action(round - 1);
	}		}

Stannius: missing semicolon in example code

2011-06-20T19:12:26Z

missing semicolon in example code

← Older revision		Revision as of 19:12, 20 June 2011
Line 52:		Line 52:
	return get_ccs_action(round);		return get_ccs_action(round);
	if(round == 1 && have_effect($effect[On the Trail]) < 1)		if(round == 1 && have_effect($effect[On the Trail]) < 1)
	return "skill transcendent olfaction"		return "skill transcendent olfaction";
	else		else
	return get_ccs_action(round - 1);		return get_ccs_action(round - 1);

Slyz at 08:42, 7 June 2011

2011-06-07T08:42:02Z

← Older revision		Revision as of 08:42, 7 June 2011
Line 32:		Line 32:
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>
	<p>Note that {{Pspan\|adventures}} is the number of adventures to spend~~, and any~~ "free" turns (choiceadventures that don't consume an adventure, usually) will not count towards this total.</p>		<p>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.</p>
	<p>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.\|		<p>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.\|

Bale: semicolons are legal in macros!

2010-10-25T06:51:20Z

semicolons are legal in macros!

← Older revision		Revision as of 06:51, 25 October 2010
Line 29:		Line 29:

	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>		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}} contains a semicolon it will use {{Pspan\|filter}} as a macro ~~with semicolons replaced by line breaks~~.</p>		<p>If {{Pspan\|filter}} contains a semicolon it will use {{Pspan\|filter}} as a macro.</p>
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>

Bale: Document the undocumented macro feature!

2010-10-25T01:49:30Z

Document the undocumented macro feature!

← Older revision		Revision as of 01:49, 25 October 2010
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 ~~the~~ combat action filter. ~~This~~ is the name of a top-level function which modifies the current CCS. ~~The~~ combat filter 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 into a script.\|		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.</p>		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}} contains a semicolon it will use {{Pspan\|filter}} as a macro with semicolons replaced by line breaks.</p>
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>

Heeheehee at 23:48, 11 July 2010

2010-07-11T23:48:37Z

← Older revision		Revision as of 23:48, 11 July 2010
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 the combat action filter. This is the name of a function which modifies the current CCS. The combat filter 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 into a script.\|		p3desc={{Pspan\|filter}} is the combat action filter. This is the name of a top-level function which modifies the current CCS. The combat filter 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 into a script.\|
	}}\|		}}\|

Line 99:		Line 99:
	see_also={{SeeAlso\|adv1}}\|		see_also={{SeeAlso\|adv1}}\|
	cli_equiv=The CLI command "adv" works similarly.\|		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.		special=This function will return false if KoLmafia conditions are met before completing the specified number of turns.</p><p>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]]		[[Category:Adventuring]]

Bale: clarify auto-stops

2010-06-26T22:14:23Z

clarify auto-stops

← Older revision		Revision as of 22:14, 26 June 2010
Line 30:		Line 30:
	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>		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>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</p>
	<p>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, auto-~~stopping due to a special event such as getting~~ a demon name or hobo glyph~~, or auto-stopping due to satisfied conditions~~.</p>		<p>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.</p>
	<p>Note that {{Pspan\|adventures}} is the number of adventures to spend, and any "free" turns (choiceadventures that don't consume an adventure, usually) will not count towards this total.</p>		<p>Note that {{Pspan\|adventures}} is the number of adventures to spend, and any "free" turns (choiceadventures that don't consume an adventure, usually) will not count towards this total.</p>
	<p>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.\|		<p>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.\|

← Older revision		Revision as of 05:56, 22 November 2019
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 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.\|		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.\|
	}}\|		}}\|

← Older revision		Revision as of 21:13, 3 December 2016
Line 97:		Line 97:
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

	see_also={{SeeAlso\|adv1}}\|		see_also={{SeeAlso\|adv1\|run_combat}}\|
	cli_equiv=The CLI command "adv" works similarly.\|		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.</p><p>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].		special=This function will return false if KoLmafia conditions are met before completing the specified number of turns.</p><p>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].

← Older revision		Revision as of 08:42, 7 June 2011
Line 32:		Line 32:
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>
	<p>Note that {{Pspan\|adventures}} is the number of adventures to spend~~, and any~~ "free" turns (choiceadventures that don't consume an adventure, usually) will not count towards this total.</p>		<p>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.</p>
	<p>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.\|		<p>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.\|

← Older revision		Revision as of 06:51, 25 October 2010
Line 29:		Line 29:

	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>		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}} contains a semicolon it will use {{Pspan\|filter}} as a macro ~~with semicolons replaced by line breaks~~.</p>		<p>If {{Pspan\|filter}} contains a semicolon it will use {{Pspan\|filter}} as a macro.</p>
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>

← Older revision		Revision as of 01:49, 25 October 2010
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 ~~the~~ combat action filter. ~~This~~ is the name of a top-level function which modifies the current CCS. ~~The~~ combat filter 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 into a script.\|		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.</p>		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}} contains a semicolon it will use {{Pspan\|filter}} as a macro with semicolons replaced by line breaks.</p>
	<p>If {{Pspan\|filter}} is omitted or assigned an empty string, this function will use your current CCS / battle action.</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 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.</p>		<p>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.</p>