Run choice - Revision history

Philmasterplus at 19:59, 1 January 2021

2021-01-01T19:59:20Z

← Older revision		Revision as of 19:59, 1 January 2021
Line 2:		Line 2:
	\|name=run_choice		\|name=run_choice
	\|function1.return_type=buffer		\|function1.return_type=buffer
	\|function1.description=Run the current choice adventure by selecting a choice number, optionally choosing to automate any resulting fight and specifying additional URL parameters.		\|function1.description=Run the current choice adventure by selecting a choice number, optionally choosing to automate any resulting fight, and possibly specifying additional URL parameters.
	\|function1.param1=choice		\|function1.param1=choice
	\|function1.param1.type=int		\|function1.param1.type=int

Philmasterplus at 19:57, 1 January 2021

2021-01-01T19:57:36Z

← Older revision		Revision as of 19:57, 1 January 2021
Line 2:		Line 2:
	\|name=run_choice		\|name=run_choice
	\|function1.return_type=buffer		\|function1.return_type=buffer
	\|function1.description=Run the current choice adventure by selecting a choice number.		\|function1.description=Run the current choice adventure by selecting a choice number, optionally choosing to automate any resulting fight and specifying additional URL parameters.
	\|function1.param1=choice		\|function1.param1=choice
	\|function1.param1.type=int		\|function1.param1.type=int
Line 11:		Line 11:
	\|function1.param2.default=true		\|function1.param2.default=true
	\|function1.param2.description=If <code>true</code> and the choice resunts in a combat, KoLmafia will automate the fight. If <code>false</code>, KoLmafia will stop when the fight begins.		\|function1.param2.description=If <code>true</code> and the choice resunts in a combat, KoLmafia will automate the fight. If <code>false</code>, KoLmafia will stop when the fight begins.
			\|function1.param3=url_params
			\|function1.param3.type=string
			\|function1.param3.optional=yes
			\|function1.param3.description=URL parameter string to append when submitting the choice request.
	\|function2.return_type=buffer		\|function2.return_type=buffer
	\|function2.description=Run the current choice adventure by selecting a choice number and specifying additional URL parameters.		\|function2.description=Run the current choice adventure by selecting a choice number and specifying additional URL parameters.
Line 22:		Line 26:
	<p>Proceeds to run a choice by selecting the provided choice number. If the provided number is <code>-1</code>, KoLmafia will use your current [[Choice Adventures\|choice adventure preferences]]. This function returns the HTML of the choice result page (not just what is displayed, but all markup). This is most commonly used to finish up choices started via {{f\|visit_url}}.</p>		<p>Proceeds to run a choice by selecting the provided choice number. If the provided number is <code>-1</code>, KoLmafia will use your current [[Choice Adventures\|choice adventure preferences]]. This function returns the HTML of the choice result page (not just what is displayed, but all markup). This is most commonly used to finish up choices started via {{f\|visit_url}}.</p>

	<p>~~The second form (with the~~ {{pspan\|url_params}} ~~parameter) can be~~ used to ~~automate fights that require additional URL parameters~~. For example, if you are in choice adventure #1182 and call <kbd>run_choice(1, "piece=1936")</kbd>, KoLmafia will send a request to the server using <samp>choice.php?option=1&pwd=<pwd_hash>&whichchoice=1182&piece=1936</samp>. You can specify multiple parameters separated by ampersands (<code>&</code>).</p>		<p>If {{pspan\|url_params}} is provided, KoLmafia will append it to the URL used to submit the choice request. For example, if you are in choice adventure #1182 and call <kbd>run_choice(1, "piece=1936")</kbd>, KoLmafia will send a request to the server using <samp>choice.php?option=1&pwd=<pwd_hash>&whichchoice=1182&piece=1936</samp>. You can specify multiple parameters separated by ampersands (<code>&</code>).</p>

			<p>The second form (without the {{pspan\|automate_fights}} parameter) always automates the resulting fight (if any).</p>

	<p>A handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing <kbd>ashq run_choice(choice)</kbd> into the gCLI will finish up the choice for you using your selected choice. Note that <code>ashq</code> is necessary rather than <code>ash</code> to avoid spewing the entire choice results page into the gCLI.</p>		<p>A handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing <kbd>ashq run_choice(choice)</kbd> into the gCLI will finish up the choice for you using your selected choice. Note that <code>ashq</code> is necessary rather than <code>ash</code> to avoid spewing the entire choice results page into the gCLI.</p>

	<p>The second form was added in [https://kolmafia.us/threads/19537-law-of-averages-is-reusable-add-ability-to-specify-extra-fields-when-automati.24204/ r19537].</p>		<p>The {{pspan\|url_params}} parameter (and the second form) was added in [https://kolmafia.us/threads/19537-law-of-averages-is-reusable-add-ability-to-specify-extra-fields-when-automati.24204/ r19537].</p>
	\|code1={{CodeSample		\|code1={{CodeSample
	\|title=Code Samples		\|title=Code Samples

Philmasterplus at 19:45, 1 January 2021

2021-01-01T19:45:10Z

← Older revision		Revision as of 19:45, 1 January 2021
Line 25:		Line 25:

	<p>A handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing <kbd>ashq run_choice(choice)</kbd> into the gCLI will finish up the choice for you using your selected choice. Note that <code>ashq</code> is necessary rather than <code>ash</code> to avoid spewing the entire choice results page into the gCLI.</p>		<p>A handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing <kbd>ashq run_choice(choice)</kbd> into the gCLI will finish up the choice for you using your selected choice. Note that <code>ashq</code> is necessary rather than <code>ash</code> to avoid spewing the entire choice results page into the gCLI.</p>

			<p>The second form was added in [https://kolmafia.us/threads/19537-law-of-averages-is-reusable-add-ability-to-specify-extra-fields-when-automati.24204/ r19537].</p>
	\|code1={{CodeSample		\|code1={{CodeSample
	\|title=Code Samples		\|title=Code Samples

Philmasterplus: Use Template:FunctionEmbed, add documentation for second form

2021-01-01T19:42:45Z

Use Template:FunctionEmbed, add documentation for second form

Show changes

Fredg1: CLI equivalent

2019-11-21T22:13:22Z

CLI equivalent

← Older revision		Revision as of 22:13, 21 November 2019
Line 51:		Line 51:

	see_also={{SeeAlso\|adventure\|adv1\|visit_url\|run_combat\|run_turn}}\|		see_also={{SeeAlso\|adventure\|adv1\|visit_url\|run_combat\|run_turn}}\|
			cli_equiv=The CLI command "choice" works similarly.\|

	}}		}}

	[[Category:Adventuring]]		[[Category:Adventuring]]

AlbinoRhino at 00:45, 25 May 2017

2017-05-25T00:45:54Z

← Older revision		Revision as of 00:45, 25 May 2017
Line 24:		Line 24:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This is a personalized version of [[adv1\|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, [[run_combat\|run_combat()]] is used.\|		description=This is a personalized version of [[adv1\|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a choice is encountered it selects the appropriate choice per your settings for that choice adventure and assigns the results to the page_text variable. (Effectively the same as using run_choice(-1)). If a combat is encountered instead of a choice adventure, [[run_combat\|run_combat()]] is used.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

AlbinoRhino at 00:41, 25 May 2017

2017-05-25T00:41:28Z

← Older revision		Revision as of 00:41, 25 May 2017
Line 18:		Line 18:


	function_description=Proceeds to run a choice using your current KoLmafia settings. This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url\|visit_url()]].</p><p>		function_description=Proceeds to run a choice, selecting the provided choice number (or, if the provided choice number = -1, using your current KoLmafia settings). This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url\|visit_url()]].</p><p>

	Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.\|		Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.\|

AlbinoRhino at 00:37, 25 May 2017

2017-05-25T00:37:41Z

← Older revision		Revision as of 00:37, 25 May 2017
Line 24:		Line 24:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.\|		description=This is a personalized version of [[adv1\|adv1()]] that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, [[run_combat\|run_combat()]] is used.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

AlbinoRhino: Created page with "{{ #vardefine:name|run_choice}}{{ #vardefine:return_type|buffer}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}|..."

2017-05-24T22:24:47Z

Created page with "{{ #vardefine:name|run_choice}}{{ #vardefine:return_type|buffer}}{{ FunctionPage| name={{#var:name}}| function1={{Function| name={{#var:name}}| aggregate={{#var:aggregate}}|..."

New page

{{
#vardefine:name|run_choice}}{{
#vardefine:return_type|buffer}}{{

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|choice}}|
p1desc={{Pspan|choice}} is the number of the choice option you wish to take. Use "-1" to automate the rest of the choice using existing choice adventure settings.|

}}|

function_description=Proceeds to run a choice using your current KoLmafia settings. This function returns the HTML from the choice page (not just what is displayed, but all markup). Most commonly used to finish up choices started via [[visit_url|visit_url()]].</p><p>

Another handy use for this function is to finish up choices that were started in the relay browser, or were interrupted (i.e. mafia aborted for you to manually make a choice selection). Typing "ashq run_choice(choice)" into the CLI will finish up the choice for you using your selected choice. Note that "ashq" is necessary rather than "ash" to avoid spewing the entire choice results page into the CLI.|

code1={{CodeSample|
title=Code Sample|
description=This is a personalized version of adv1() that is capable of returning information about which adventure is encountered so that you can look for a specific choice adventure. If a combat is encountered instead of a choice adventure, run_combat() is used.|
code=
<syntaxhighlight>
int run_adv(location place) {
string page_text = to_url(place).visit_url();
string choiceAdventure = "-1";
matcher m_choice = create_matcher("whichchoice value=(\\d+)", page_text);
while(page_text.contains_text("choice.php")) {
m_choice.reset(page_text);
m_choice.find();
choiceAdventure = m_choice.group(1);
string choice_num = get_property("choiceAdventure"+ choiceAdventure);

if(choice_num == "0") abort("Manual Control for "+ choiceAdventure);
if(choice_num == "") abort("Unsupported Choice Adventure!");

page_text = run_choice(choice_num);
}
if(page_text.contains_text("Combat"))
run_combat();
return choiceAdventure.to_int();
}
</syntaxhighlight>}}|

see_also={{SeeAlso|adventure|adv1|visit_url|run_combat|run_turn}}|

}}

[[Category:Adventuring]]