Daily Deeds - Revision history

Darzil: /* Skill */

2016-08-07T20:04:21Z

Skill

← Older revision		Revision as of 20:04, 7 August 2016
Line 94:		Line 94:

	Skill\|displayText\|preference\|skillName\|maxCasts		Skill\|displayText\|preference\|skillName\|maxCasts

			Skill\|displayText\|preference\|skillName\|maxCasts\|toolTip\|compMessage

	*skillName- the name of the skill that will be cast. If not specified, will default to displayText. Must be specified if maxCasts are specified.		*skillName- the name of the skill that will be cast. If not specified, will default to displayText. Must be specified if maxCasts are specified.

Darzil: /* Item */

2016-08-07T20:03:17Z

Item

← Older revision		Revision as of 20:03, 7 August 2016
Line 79:		Line 79:

	Item\|displayText\|preference\|itemName\|maxUses		Item\|displayText\|preference\|itemName\|maxUses

			Item\|displayText\|preference\|itemName\|maxUses\|toolTip\|compMessage

	*itemName - the name of the item that will be used. If not specified, will default to displayText.		*itemName - the name of the item that will be used. If not specified, will default to displayText.

Darzil: /* Command */

2016-08-07T20:02:55Z

Command

← Older revision		Revision as of 20:02, 7 August 2016
Line 62:		Line 62:

	Command\|displayText\|preference\|command\|maxUses		Command\|displayText\|preference\|command\|maxUses

			Command\|displayText\|preference\|command\|maxUses\|toolTip\|CompMessage

	*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.		*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.

Darzil: /* Simple */

2016-08-07T20:02:19Z

Simple

← Older revision		Revision as of 20:02, 7 August 2016
Line 41:		Line 41:

	Simple\|displayText\|command\|maxUses		Simple\|displayText\|command\|maxUses

			Simple\|displayText\|command\|maxUses\|toolTip\|compMessage

	*displayText - the text that will be displayed on the button		*displayText - the text that will be displayed on the button
	*command - the command to execute. If not specified, will default to displayText.		*command - the command to execute. If not specified, will default to displayText.
	*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <clicks>/<maxUses> will be displayed to the right of the button.		*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <clicks>/<maxUses> will be displayed to the right of the button.
			*toolTip - text that will display when you mouse over the button.
			*compMessage - message that displays when you have used the button (maxUses times if specified), rather than the button vanishing.

	After clicking a simple deed, the button will be immediately disabled unless maxUses>1 is specified.		After clicking a simple deed, the button will be immediately disabled unless maxUses>1 is specified.

Vorzer: "equip greatampant" no longer works in the latest version, so I changed it to "equip pants American", which still does.

2013-10-10T14:11:55Z

"equip greatampant" no longer works in the latest version, so I changed it to "equip pants American", which still does.

← Older revision		Revision as of 14:11, 10 October 2013
Line 108:		Line 108:

	<pre style="white-space:pre-wrap;">		<pre style="white-space:pre-wrap;">
	$CUSTOM\|Combo\|GAPants\|_gapBuffs\|5\|$ITEM\|free spells\|false\|equip ~~greatampant~~; gap skill\|$ITEM\|elem & tough\|false\|equip ~~greatampant~~; gap structure\|$ITEM\|+25%ItemD\|false\|equip ~~greatampant~~; gap vision\|$ITEM\|+100%Mox\|false\|equip ~~greatampant~~; gap speed\|$ITEM\|5xCrit\|false\|equip ~~greatampant~~; gap accuracy</pre>		$CUSTOM\|Combo\|GAPants\|_gapBuffs\|5\|$ITEM\|free spells\|false\|equip pants American; gap skill\|$ITEM\|elem & tough\|false\|equip pants American; gap structure\|$ITEM\|+25%ItemD\|false\|equip pants American; gap vision\|$ITEM\|+100%Mox\|false\|equip pants American; gap speed\|$ITEM\|5xCrit\|false\|equip pants American; gap accuracy</pre>

	[[File:GAPdeed.png]]		[[File:GAPdeed.png]]

Roippi: add simple deed

2012-02-24T08:03:06Z

add simple deed

← Older revision		Revision as of 08:03, 24 February 2012
Line 23:		Line 23:
	== Custom Deeds ==		== Custom Deeds ==

	All deeds are specified by one comma-delimited preference "dailyDeedsOptions". Order matters. Built-in deeds are simply called by referring to their built-in name; these are viewable by pulling up the Daily Deeds tab and looking in the "Built-in Deeds" list~~. In the source code these can be found in DailyDeedsPanel.BUILTIN_DEEDS~~.		All deeds are specified by one comma-delimited preference "dailyDeedsOptions". Order matters. Built-in deeds are simply called by referring to their built-in name; these are viewable by pulling up the Daily Deeds tab and looking in the "Built-in Deeds" list.

	Custom deeds provide the user with a way of adding buttons or text to their daily deeds panel that is not natively provided for. All deeds start with the keyword '''$CUSTOM''' followed by a pipe symbol, '''\|'''. As you are constructing a custom deed, you separate the different arguments with pipes.		Custom deeds provide the user with a way of adding buttons or text to their daily deeds panel that is not natively provided for. All deeds start with the keyword '''$CUSTOM''' followed by a pipe symbol, '''\|'''. As you are constructing a custom deed, you separate the different arguments with pipes.

	All deed types except for Text require a preference to track. If you want to add a button that is always enabled, use a dummy preference (you do not have to create one, just specify one that doesn't exist, such as "false").		All deed types except for Text and Simple require a preference to track. If you want to add a button that is always enabled, use a dummy preference (you do not have to create one, just specify one that doesn't exist, such as "false").

	There are currently 5 different types of custom deeds. Remember that all of these "acceptable forms" are prefaced by $CUSTOM\|.		There are currently 6 different types of custom deeds. Remember that all of these "acceptable forms" are prefaced by $CUSTOM\|.

			==== Simple ====
			As the name implies, this type of deed is the simplest to use. Designed for users who do not want to muck around with preferences.

			acceptable forms:

			Simple\|displayText

			Simple\|displayText\|command

			Simple\|displayText\|command\|maxUses

			*displayText - the text that will be displayed on the button
			*command - the command to execute. If not specified, will default to displayText.
			*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <clicks>/<maxUses> will be displayed to the right of the button.

			After clicking a simple deed, the button will be immediately disabled unless maxUses>1 is specified.

	==== Command ====		==== Command ====
Line 42:		Line 59:
	Command\|displayText\|preference\|command\|maxUses		Command\|displayText\|preference\|command\|maxUses

	*displayText - the text that will be displayed on the button
	*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.		*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.
	*command - the command to execute. If not specified, will default to displayText.
	*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.

	Further information regarding custom preferences and button enabling/disabling can be found [http://kolmafia.us/showthread.php?7347-Daily-Deeds-support&p=58295&viewfull=1#post58295 here].		Further information regarding custom preferences and button enabling/disabling can be found [http://kolmafia.us/showthread.php?7347-Daily-Deeds-support&p=58295&viewfull=1#post58295 here].
Line 73:		Line 87:
	Skill\|displayText\|preference\|skillName\|maxCasts		Skill\|displayText\|preference\|skillName\|maxCasts

	*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxCasts is not specified.
	*skillName- the name of the skill that will be cast. If not specified, will default to displayText. Must be specified if maxCasts are specified.		*skillName- the name of the skill that will be cast. If not specified, will default to displayText. Must be specified if maxCasts are specified.
	*maxCasts - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxCasts> will be displayed to the right of the button.


	==== Combo ====		==== Combo ====

Roippi: /* Item */

2012-02-08T14:10:48Z

Item

← Older revision		Revision as of 14:10, 8 February 2012
Line 54:		Line 54:
	acceptable forms:		acceptable forms:

	~~BooleanItem~~\|displayText\|preference		Item\|displayText\|preference

	~~BooleanItem~~\|displayText\|preference\|itemName		Item\|displayText\|preference\|itemName

	Item\|displayText\|preference\|itemName\|maxUses		Item\|displayText\|preference\|itemName\|maxUses

Soriah: /* Command */ Clarified that the explanation referred to custom rather than in-built preferences.

2011-10-20T23:12:00Z

Command: Clarified that the explanation referred to custom rather than in-built preferences.

← Older revision		Revision as of 23:12, 20 October 2011
Line 47:		Line 47:
	*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.		*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.

	Further information regarding preferences and button enabling/disabling can be found [http://kolmafia.us/showthread.php?7347-Daily-Deeds-support&p=58295&viewfull=1#post58295 here].		Further information regarding custom preferences and button enabling/disabling can be found [http://kolmafia.us/showthread.php?7347-Daily-Deeds-support&p=58295&viewfull=1#post58295 here].

	==== Item ====		==== Item ====

Soriah: /* Command */ Added link to roippi's explanation of preferences.

2011-10-20T23:06:37Z

Command: Added link to roippi's explanation of preferences.

← Older revision		Revision as of 23:06, 20 October 2011
Line 46:		Line 46:
	*command - the command to execute. If not specified, will default to displayText.		*command - the command to execute. If not specified, will default to displayText.
	*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.		*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.

			Further information regarding preferences and button enabling/disabling can be found [http://kolmafia.us/showthread.php?7347-Daily-Deeds-support&p=58295&viewfull=1#post58295 here].

	==== Item ====		==== Item ====

Roippi: /* Command */

2011-08-23T10:06:06Z

Command

← Older revision		Revision as of 10:06, 23 August 2011
Line 43:		Line 43:

	*displayText - the text that will be displayed on the button		*displayText - the text that will be displayed on the button
	preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.		*preference - the preference to track for enabling/disabling the button. Default threshold for disabling the button is 1 if maxUses is not specified.
	*command - the command to execute. If not specified, will default to displayText.		*command - the command to execute. If not specified, will default to displayText.
	*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.		*maxUses - an arbitrary integer. Specifies a threshold to disable the button at. A counter in the form of <preference>/<maxUses> will be displayed to the right of the button.