Counters - Revision history

Lostcalpolydude: Update documentation

2019-03-21T16:52:59Z

Update documentation

← Older revision		Revision as of 16:52, 21 March 2019
Line 9:		Line 9:
	** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".		** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".
	*** The title can include one or more instances of '''loc=X''', where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.		*** The title can include one or more instances of '''loc=X''', where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.
	*** The title can include '''type=wander''' which will cause it to remain at 0 turns until it is explicitly cleared. Wandering monsters work this way and KoLmafia explicitly clears the ~~counter~~ after the wandering monster is encountered.		*** The title can include '''type=wander''' which will cause it to remain at 0 turns until it is explicitly cleared. Wandering monsters work this way and KoLmafia explicitly clears the counters it creates after the wandering monster is encountered.
	** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.		** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.
	* '''warn''' title: This will change an existing counter so that it does not have a loc=* paremeter, ensuring that it will stop you when it expires.		* '''warn''' title: This will change an existing counter so that it does not have a loc=* paremeter, ensuring that it will stop you when it expires.

Lostcalpolydude at 18:52, 7 October 2016

2016-10-07T18:52:11Z

← Older revision		Revision as of 18:52, 7 October 2016
Line 9:		Line 9:
	** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".		** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".
	*** The title can include one or more instances of '''loc=X''', where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.		*** The title can include one or more instances of '''loc=X''', where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.
	*** The title can include '''type=wander''' which will cause it to remain at 0 turns until it is explicitly cleared. Wandering monsters work this way and ~~mafia~~ explicitly clears the counter after the wandering monster is encountered.		*** The title can include '''type=wander''' which will cause it to remain at 0 turns until it is explicitly cleared. Wandering monsters work this way and KoLmafia explicitly clears the counter after the wandering monster is encountered.
	** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.		** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.
			* '''warn''' title: This will change an existing counter so that it does not have a loc=* paremeter, ensuring that it will stop you when it expires.
			* '''nowarn''' title: This will change an existing counter so that it has loc=* as a parameter, ensuring that it will not stop you when it expires.

	Example: to add a fortune cookie counter to expire in 88 turns, use this command:		Example: to add a fortune cookie counter to expire in 88 turns, use this command:
Line 17:		Line 19:
	To add a counter that will not abort in The Haunted Gallery or The Haunted Bathroom, use this:		To add a counter that will not abort in The Haunted Gallery or The Haunted Bathroom, use this:
	:<code> counters add 10 example loc=392 loc=394</code>		:<code> counters add 10 example loc=392 loc=394</code>

			To make KoLmafia's Digitize Monster counter stop your adventuring, use this:
			:<code> counters warn Digitize Monster</code>


	[[Category:CLI Commands]]		[[Category:CLI Commands]]

Bale at 21:51, 31 July 2016

2016-07-31T21:51:39Z

← Older revision		Revision as of 21:51, 31 July 2016
Line 8:		Line 8:
	** '''number''' the is the number of turns until the counter expires		** '''number''' the is the number of turns until the counter expires
	** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".		** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".
	*** The title can include one or more instances of loc=X, where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.		*** The title can include one or more instances of '''loc=X''', where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.
			*** The title can include '''type=wander''' which will cause it to remain at 0 turns until it is explicitly cleared. Wandering monsters work this way and mafia explicitly clears the counter after the wandering monster is encountered.
	** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.		** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.

Lostcalpolydude at 17:38, 30 July 2016

2016-07-30T17:38:09Z

← Older revision		Revision as of 17:38, 30 July 2016
Line 7:		Line 7:
	* '''add''' condition: This will add a counter. If the condition is an item, it will set the necessary quantity to this many more than you currently have. This also has the additional parameters: number [title img]		* '''add''' condition: This will add a counter. If the condition is an item, it will set the necessary quantity to this many more than you currently have. This also has the additional parameters: number [title img]
	** '''number''' the is the number of turns until the counter expires		** '''number''' the is the number of turns until the counter expires
	** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual"		** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual".
			*** The title can include one or more instances of loc=X, where X is an adventure id that you can go without having the counter abort adventuring. Using * for X will prevent it from aborting anywhere, making it a strictly informative counter.
	** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.		** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.

	Example: to add a fortune cookie counter to expire in 88 turns, use this command:		Example: to add a fortune cookie counter to expire in 88 turns, use this command:
	:<code> counters add 88 cookie fortune.gif</code>		:<code> counters add 88 cookie fortune.gif</code>

			To add a counter that will not abort in The Haunted Gallery or The Haunted Bathroom, use this:
			:<code> counters add 10 example loc=392 loc=394</code>


	[[Category:CLI Commands]]		[[Category:CLI Commands]]

Bale: CLI command

2010-09-22T07:23:24Z

CLI command

New page

{{DISPLAYTITLE:counters (CLI)}}

This is a CLI command for displaying or modifying KoLmafia's counters. Without any parameters it will display all current counters.

The possible parameters are:
* '''clear''': This will remove all current counters.
* '''add''' condition: This will add a counter. If the condition is an item, it will set the necessary quantity to this many more than you currently have. This also has the additional parameters: number [title img]
** '''number''' the is the number of turns until the counter expires
** '''title''' is an optional parameter to name the counter. If no name is given, then the counter will be named "manual"
** '''img''' is an optional image for the counter. You can use any of the images in KoL's \itemimages directory. If no image is chosen, then mafia will use watch.gif for the counter.

Example: to add a fortune cookie counter to expire in 88 turns, use this command:
:<code> counters add 88 cookie fortune.gif</code>

[[Category:CLI Commands]]