Batch close - Revision history

Philmasterplus: Clarify what functions can be batched (with footnotes), based on looking at KoLmafia r20662 source code

2021-03-14T07:47:29Z

Clarify what functions can be batched (with footnotes), based on looking at KoLmafia r20662 source code

← Older revision		Revision as of 07:47, 14 March 2021
Line 53:		Line 53:
	}}		}}
	==Functions that can be batched==		==Functions that can be batched==
	~~(TBA)~~		While in batch mode, the following functions will postpone operations until the next {{f\|batch_close}} call:

	=~~=Functions that cannot~~ be batched==		* {{f\|autosell}}
	* {{f\|~~put_closet~~}}		* {{f\|empty_closet}}<ref>While this function can be batched, doing so is not very useful in practice, since it only takes a single server request anyway.</ref>
	* {{f\|~~take_closet~~}}		* {{f\|put_closet}}<ref name="nonfunctional-closet-batch">While this function can be batched, each item transfer will still consume one request. This is due to changes in KoL's closet interface.[https://kolmafia.us/threads/new-hangks-and-closet-interface.6480]</ref>
			* {{f\|put_display}}
			* {{f\|put_shop}}
			* {{f\|put_stash}}
			* {{f\|reprice_shop}}
			* {{f\|sell}}
			* {{f\|take_closet}}<ref name="nonfunctional-closet-batch" />
			* {{f\|take_display}}
			* {{f\|take_shop}}
			* {{f\|take_stash}}<ref>While this function can be batched, each item transfer will still consume one request. This is due to limitations in KoL's clan stash interface. This limitation does not apply to {{f\|put_stash}}.</ref>
	* {{f\|take_storage}}		* {{f\|take_storage}}

	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

Philmasterplus: Update outdated info; add sections for known functions that (don't) work with batch mode

2021-03-12T11:50:39Z

Update outdated info; add sections for known functions that (don't) work with batch mode

← Older revision		Revision as of 11:50, 12 March 2021
Line 14:		Line 14:

	function_description=		function_description=
	After a batch_open(), certain functions that generate a server hit on each call are queued up, rather than executed immediately. When batch_close() is called, it will then execute all of them at once (hopefully with fewer server hits).</p>		After a {{f\|batch_open}}, certain functions that generate a server hit on each call are queued up, rather than executed immediately. When {{f\|batch_close}} is called, it will then execute all of them at once (hopefully with fewer server hits).</p>
	<p>The functions that benefit from being batched include autosell~~(), mallsell(), and the~~ various put_X(), take_X() functions that move items to or from the ~~closet~~, ~~storage, display~~, or stash. Most of the KoL interfaces for these are capable of transferring up to 11 items at once, but that can't otherwise be expressed in ASH. More details:
			<p>The functions that benefit from being batched include {{f\|autosell}} as well as various put_X(), take_X() functions that move items to or from the display, shop, or stash. Most of the KoL interfaces for these are capable of transferring up to 11 items at once, but that can't otherwise be expressed in ASH. More details:</p>

	* Caution is required when using more than one batchable function in a single batch, since they won't be executed in the same order you wrote them.		* Caution is required when using more than one batchable function in a single batch, since they won't be executed in the same order you wrote them.
	** What happens in this case is that all instances of the first encountered function are executed, then all instances of the second encountered function, and so on.		** What happens in this case is that all instances of the first encountered function are executed, then all instances of the second encountered function, and so on.
	** This should produce the expected results in cases such as a loop that pulls an item from storage, and then puts it in your closet.		** This should produce the expected results in cases such as a loop that pulls an item from storage, and then puts it in your closet.
	*** Inside of a batch, all the pulls get processed at once, and then all the closet puts.		*** Inside of a batch, all the pulls get processed at once, and then all the closet puts.
	* put_X() and take_X() with the same source ~~(the closet, for example) cannot~~ be used in the same batch.		* put_X() and take_X() with the same source ''can'' be used in the same batch as of [https://kolmafia.us/threads/13272-ash-batching-of-commands-will-now-save-up-and-batch-multiple-prefixes-of-the-s.14331/ r13272]. ([https://kolmafia.us/threads/improve-ash-batching.14329/ feature thread])
	* Batches are accumulated on a per-script-invocation basis.		* Batches are accumulated on a per-script-invocation basis.
	** Having an open batch does not affect execution of any other script that's running at the same time.		** Having an open batch does not affect execution of any other script that's running at the same time.
	** Any commands batched by a script that was aborted are discarded - they won't mysteriously be executed by the next script that calls batch_close()		** Any commands batched by a script that was aborted are discarded - they won't mysteriously be executed by the next script that calls {{f\|batch_close}}
	~~</p>~~<p>Any failure of batched commands can be captured and tested via the return value of batch_close(), just as you'd normally check the return value of the individual functions being batched. However, there's no way to tell just how much progress had been made before the failure, so it's unlikely that a script could meaningfully continue after that point.</p>
	<p>(Note: this function description taken in its entirety, with only slight formatting changes, from jasonharper's log notes on r7552.)		<p>Any failure of batched commands can be captured and tested via the return value of {{\|batch_close}}, just as you'd normally check the return value of the individual functions being batched. However, there's no way to tell just how much progress had been made before the failure, so it's unlikely that a script could meaningfully continue after that point.</p>

			<p>(Note: this function description taken in its entirety, with only slight formatting changes, from jasonharper's log notes on r7552.)</p>

			<p>Note: Due to KoL's closet/storage interface revamp (aligns with KoLmafia r9252), closet- and storage-related operations can no longer be batched.</p>
	\|		\|

Line 46:		Line 52:
	see_also={{SeeAlso\|batch_open}}\|		see_also={{SeeAlso\|batch_open}}\|
	}}		}}
			==Functions that can be batched==
			(TBA)

			==Functions that cannot be batched==
			* {{f\|put_closet}}
			* {{f\|take_closet}}
			* {{f\|take_storage}}

	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

Heeheehee: Extraneous brace removed.

2010-06-26T17:45:05Z

Extraneous brace removed.

← Older revision		Revision as of 17:45, 26 June 2010
Line 42:		Line 42:

	batch_close();		batch_close();

	}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

Bale at 05:31, 22 May 2010

2010-05-22T05:31:20Z

← Older revision		Revision as of 05:31, 22 May 2010
Line 5:		Line 5:
	FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	~~function_category=Miscellaneous\|~~

	function1={{Function\|		function1={{Function\|
Line 49:		Line 48:
	see_also={{SeeAlso\|batch_open}}\|		see_also={{SeeAlso\|batch_open}}\|
	}}		}}

			[[Category:Miscellaneous Functions]]

Bale: The code sample is much better now.

2010-03-09T08:42:00Z

The code sample is much better now.

← Older revision		Revision as of 08:42, 9 March 2010
Line 29:		Line 29:
	\|		\|

	~~improvecode=yes\|~~

	code1={{CodeSample\|		code1={{CodeSample\|

Bale at 08:40, 9 March 2010

2010-03-09T08:40:41Z

← Older revision		Revision as of 08:40, 9 March 2010
Line 33:		Line 33:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This ~~short program~~ will ~~mall or autosell ''everything'' in~~ the ~~players inventory. Because batch_open() and batch_close()~~ are ~~used, it will mall items~~ 11 ~~at a time~~ to ~~save~~ server hits ~~and similarly minimize the number of commands to remove items from the closet and then autosell~~.\|		description=This will remove all items from a characters closet. None of the items are removed until the batch is closed so that they can be removed in groups of 11 to minimize server hits.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>
	~~void sell_everything() {~~		batch_open();
	batch_open();
			// Check every item to see if there are any in the closet.
	~~// Empty out Hagnk's if it hasn't been emptied this ascension~~		foreach doodad in $items[]
	~~if(get_property("lastEmptiedStorage").to_int() != my_ascensions())~~		if(closet_amount(doodad)>0)
	~~visit_url("storage.php?action=takeall&pwd");~~		take_closet(closet_amount(doodad), doodad);
	~~cli_execute("outfit birthday suit"); // Strip naked~~
			batch_close();
	// ~~Now check~~ every item in the ~~entire game that the player owns~~
	foreach doodad in $items[] ~~if(available_amount(doodad) > 0) {~~
	if(closet_amount(doodad)>0) ~~// empty the closet of this item~~
	take_closet(closet_amount(doodad), doodad);
	~~if(is_tradeable(doodad)) // If the item can be malled, put it in the shop~~
	~~put_shop(historical_price(doodad), 0, doodad);~~
	~~else if(autosell_price(doodad) > 0) // If it can't be malled, autosell it~~
	~~autosell(available_amount(doodad), doodad);~~
	}

	batch_close();
	}

	~~void main() {~~
	~~sell_everything();~~
	}		}
	</syntaxhighlight>}}\|		</syntaxhighlight>}}\|

StDoodle at 23:14, 8 March 2010

2010-03-08T23:14:26Z

← Older revision		Revision as of 23:14, 8 March 2010
Line 28:		Line 28:
	<p>(Note: this function description taken in its entirety, with only slight formatting changes, from jasonharper's log notes on r7552.)		<p>(Note: this function description taken in its entirety, with only slight formatting changes, from jasonharper's log notes on r7552.)
	\|		\|

			improvecode=yes\|

	code1={{CodeSample\|		code1={{CodeSample\|

StDoodle at 21:37, 8 March 2010

2010-03-08T21:37:51Z

← Older revision		Revision as of 21:37, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|batch_close}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|batch_close}}{{
			#vardefine:return_type\|boolean}}{{

	{{FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Miscellaneous\|		function_category=Miscellaneous\|

Heeheehee: "malled" was spelled with three l's. Hagnk's had the n and g transposed.

2010-03-05T07:23:22Z

"malled" was spelled with three l's. Hagnk's had the n and g transposed.

← Older revision		Revision as of 07:23, 5 March 2010
Line 36:		Line 36:
	batch_open();		batch_open();

	// Empty out ~~Hangks~~ if it hasn't been emptied this ascension		// Empty out Hagnk's if it hasn't been emptied this ascension
	if(get_property("lastEmptiedStorage").to_int() != my_ascensions())		if(get_property("lastEmptiedStorage").to_int() != my_ascensions())
	visit_url("storage.php?action=takeall&pwd");		visit_url("storage.php?action=takeall&pwd");
Line 47:		Line 47:
	if(is_tradeable(doodad)) // If the item can be malled, put it in the shop		if(is_tradeable(doodad)) // If the item can be malled, put it in the shop
	put_shop(historical_price(doodad), 0, doodad);		put_shop(historical_price(doodad), 0, doodad);
	else if(autosell_price(doodad) > 0) // If it can't be ~~mallled~~, autosell it		else if(autosell_price(doodad) > 0) // If it can't be malled, autosell it
	autosell(available_amount(doodad), doodad);		autosell(available_amount(doodad), doodad);
	}		}

Bale at 06:55, 5 March 2010

2010-03-05T06:55:55Z

← Older revision		Revision as of 06:55, 5 March 2010
Line 30:		Line 30:
	code1={{CodeSample\|		code1={{CodeSample\|
	title=Code Sample\|		title=Code Sample\|
	description=This short program will mall or autosell ''everything'' in the players inventory. Because batch_open() and batch_close() are used, it will mall items 11 at a time to save server hits and similarly minimize the number of autosell ~~commands~~.\|		description=This short program will mall or autosell ''everything'' in the players inventory. Because batch_open() and batch_close() are used, it will mall items 11 at a time to save server hits and similarly minimize the number of commands to remove items from the closet and then autosell.\|
	code=		code=
	<syntaxhighlight>		<syntaxhighlight>

← Older revision		Revision as of 07:47, 14 March 2021
Line 53:		Line 53:
	}}		}}
	==Functions that can be batched==		==Functions that can be batched==
	~~(TBA)~~		While in batch mode, the following functions will postpone operations until the next {{f\|batch_close}} call:

	=~~=Functions that cannot~~ be batched==		* {{f\|autosell}}
	* {{f\|~~put_closet~~}}		* {{f\|empty_closet}}<ref>While this function can be batched, doing so is not very useful in practice, since it only takes a single server request anyway.</ref>
	* {{f\|~~take_closet~~}}		* {{f\|put_closet}}<ref name="nonfunctional-closet-batch">While this function can be batched, each item transfer will still consume one request. This is due to changes in KoL's closet interface.[https://kolmafia.us/threads/new-hangks-and-closet-interface.6480]</ref>
			* {{f\|put_display}}
			* {{f\|put_shop}}
			* {{f\|put_stash}}
			* {{f\|reprice_shop}}
			* {{f\|sell}}
			* {{f\|take_closet}}<ref name="nonfunctional-closet-batch" />
			* {{f\|take_display}}
			* {{f\|take_shop}}
			* {{f\|take_stash}}<ref>While this function can be batched, each item transfer will still consume one request. This is due to limitations in KoL's clan stash interface. This limitation does not apply to {{f\|put_stash}}.</ref>
	* {{f\|take_storage}}		* {{f\|take_storage}}

	[[Category:Miscellaneous Functions]]		[[Category:Miscellaneous Functions]]

← Older revision		Revision as of 21:37, 8 March 2010
Line 1:		Line 1:
	{{#vardefine:name\|batch_close}}		{{
	{{#vardefine:return_type\|boolean}}		#vardefine:name\|batch_close}}{{
			#vardefine:return_type\|boolean}}{{

	{{FunctionPage\|		FunctionPage\|
	name={{#var:name}}\|		name={{#var:name}}\|
	function_category=Miscellaneous\|		function_category=Miscellaneous\|