Miscellaneous ASH Features - Revision history

Gausie: /* Additional Script Uses */

2020-06-05T08:58:28Z

Additional Script Uses

← Older revision		Revision as of 08:58, 5 June 2020
Line 160:		Line 160:
	*Executed after changing familiars but before automatically changing familiar equipment.		*Executed after changing familiars but before automatically changing familiar equipment.
	*Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.		*Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.


	=== Spading (spadingScript) ===		=== Spading (spadingScript) ===

Gausie: /* Additional Script Uses */

2020-06-05T08:58:01Z

Additional Script Uses

@@ Line 160: / Line 160: @@
 *Executed after changing familiars but before automatically changing familiar equipment.
 *Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.
 ==A little CLI help==

Theo: /* Additional Script Uses */ added familiarScript

2016-05-19T22:54:16Z

Additional Script Uses: added familiarScript

← Older revision		Revision as of 22:54, 19 May 2016
Line 155:		Line 155:
	**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.		**''amount'' is the desired amount of restoration needed or 0 to use mafia's default recovery level and target.
	*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]		*Example: Bale's [http://kolmafia.us/showthread.php?t=1780 Universal Recovery]


			=== Familiar (familiarScript) ===
			*Executed after changing familiars but before automatically changing familiar equipment.
			*Requires a special main() declaration: boolean main(). Returning true will cause normal familiar equipment switching to be skipped, while false will lead to it running after the script returns.

	==A little CLI help==		==A little CLI help==

Bale: /* Chatbot (chatbotScript) */ events

2014-11-14T09:29:09Z

Chatbot (chatbotScript): events

← Older revision		Revision as of 09:29, 14 November 2014
Line 103:		Line 103:
	=== Chatbot (chatbotScript) ===		=== Chatbot (chatbotScript) ===

	*Will execute whenever a private message is received		*Will execute whenever a private message or an event is received
			**When an event is received the message is stripped of HTML, the channel is "Events" and the sender is an empty string.
	*Requires a special main declaration which can have an optional third parameter:		*Requires a special main declaration which can have an optional third parameter:
	*:void main(string sender, string message)		*:void main(string sender, string message)
Line 110:		Line 111:
	**'message' is the message that was sent		**'message' is the message that was sent
	**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages		**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages


	=== Counters (counterScript) ===		=== Counters (counterScript) ===

Bale: /* Special Syntax Functions */ Since

2014-11-06T09:41:02Z

Special Syntax Functions: Since

← Older revision		Revision as of 09:41, 6 November 2014
Line 5:		Line 5:

	===Special Syntax Functions===		===Special Syntax Functions===

			'''[[script]]'''

			Defines a script's proper name. Mostly for use by a subsequent notify command in case the user saves the script with a custom name.

	'''[[notify]]'''		'''[[notify]]'''

	Used to send a simple kmail to the script's author, letting them know you use their script.		Used to send a simple kmail to the script's author, letting them know you use their script.

			'''[[since]]'''

			Used to inform KoLmafia of the minimum build necessary to support the script's functionality so it can abort execution with a meaningful error message.

	'''[[import]]'''		'''[[import]]'''
Line 21:		Line 29:

	Constructor function used to populate a record.		Constructor function used to populate a record.


	===Comments===		===Comments===

Bale: beforePVPScript added in r11110 and improved in r11112.

2014-11-06T05:27:06Z

beforePVPScript added in r11110 and improved in r11112.

← Older revision		Revision as of 05:27, 6 November 2014
Line 55:		Line 55:
	In addition to regular scripts, override scripts, UI scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).		In addition to regular scripts, override scripts, UI scripts, and consult scripts, mafia has a few other hooks for adding event-driven scripts. These situations are listed below, along with the preference that you can set a script name to (in parentheses).

	==== After Adventure (afterAdventureScript) ====		=== After Adventure (afterAdventureScript) ===

	*Executed just after mafia has finished an adventure.		*Executed just after mafia has finished an adventure.
Line 62:		Line 62:


	==== Before Adventure (betweenBattleScript) ====		=== Before Adventure (betweenBattleScript) ===

	*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.		*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
Line 68:		Line 68:
	*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.		*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.
	*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]		*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]


			=== Before PvP Script (beforePVPScript) ===
			* This will be executed before every PvP attack initiated through the relay browser or CLI command.
			* If you want buffs maintained during PvP (and nothing else) you can do that with:
			*: <pre>set beforePVPScript = mood execute</pre>


	=== Breaking the Prism (kingLiberatedScript) ===		=== Breaking the Prism (kingLiberatedScript) ===
Line 96:		Line 103:
	**'message' is the message that was sent		**'message' is the message that was sent
	**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages		**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages


	=== Counters (counterScript) ===		=== Counters (counterScript) ===
Line 114:		Line 122:

	:Same as the loginScript, but runs on logout. Note that an {{f\|abort}} in the script won't stop a logout unless the logout was called in (specific ways, please list).		:Same as the loginScript, but runs on logout. Note that an {{f\|abort}} in the script won't stop a logout unless the logout was called in (specific ways, please list).


	=== Planting (plantingScript) ===		=== Planting (plantingScript) ===

Lostcalpolydude: /* Chatbot (chatBotScript) */

2014-05-09T04:32:11Z

Chatbot (chatBotScript)

← Older revision		Revision as of 04:32, 9 May 2014
Line 87:		Line 87:


	=== Chatbot (~~chatBotScript~~) ===		=== Chatbot (chatbotScript) ===

	*Will execute whenever a private message is received		*Will execute whenever a private message is received

Heeheehee: /* Chatbot (chatBotScript) */ Add channel data for events.

2014-01-11T17:00:13Z

Chatbot (chatBotScript): Add channel data for events.

← Older revision		Revision as of 17:00, 11 January 2014
Line 95:		Line 95:
	**'sender' is the name of the player who sent the message		**'sender' is the name of the player who sent the message
	**'message' is the message that was sent		**'message' is the message that was sent
	**'channel' is "/clan" for clan messages and the empty string for private messages		**'channel' is "/clan" for clan messages, "Events" for chat notifications (e.g. "New message received from Bale."), and the empty string for private messages

	=== Counters (counterScript) ===		=== Counters (counterScript) ===

Bale: /* Between Adventure (betweenBattleScript) */

2014-01-03T05:46:25Z

Between Adventure (betweenBattleScript)

← Older revision		Revision as of 05:46, 3 January 2014
Line 62:		Line 62:


	==== ~~Between~~ Adventure (betweenBattleScript) ====		==== Before Adventure (betweenBattleScript) ====

	*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.		*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.

Bale: /* Between Battle (betweenBattleScript) */

2014-01-03T05:46:07Z

Between Battle (betweenBattleScript)

← Older revision		Revision as of 05:46, 3 January 2014
Line 62:		Line 62:


	==== Between ~~Battle~~ (betweenBattleScript) ====		==== Between Adventure (betweenBattleScript) ====

	*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.		*Executed whenever mafia is about to enter a combat. That means before every adventure if auto-adventuring, or before using an item that could lead to combat such as black pudding or drum machine.
Line 68:		Line 68:
	*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.		*By default this only works for automated adventuring. If you wish it to fire when you're using the relay browser then turn it on in General -> Preferences -> - Relay Browser or set the property relayRunsBeforeBattleScript to true.
	*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]		*Example: Zarqon's [http://kolmafia.us/showthread.php?t=1240 Best Between Battle]


	=== Breaking the Prism (kingLiberatedScript) ===		=== Breaking the Prism (kingLiberatedScript) ===