WoW:SecureActionButtonTemplate - Revision history

Move page script: Move page script moved page SecureActionButtonTemplate to WoW:SecureActionButtonTemplate without leaving a redirect

2023-08-15T04:48:56Z

Move page script moved page SecureActionButtonTemplate to SecureActionButtonTemplate without leaving a redirect

← Older revision

Revision as of 04:48, 15 August 2023

Bear: /* Modified attributes */

2020-05-17T21:17:53Z

Modified attributes

← Older revision		Revision as of 21:17, 17 May 2020
Line 1:		Line 1:
	{{uitech}}The '''SecureActionButtonTemplate''' was introduced in [[Patch 2.0]] to allow addons to perform protected actions -- casting spells, executing macros, etc -- by specifying button behavior via its attributes.		{{uitech}}
			The '''SecureActionButtonTemplate''' was introduced in [[Patch 2.0]] to allow addons to perform protected actions -- casting spells, executing macros, etc -- by specifying button behavior via its attributes.

	== Creating a SecureActionButton ==		== Creating a SecureActionButton ==
Line 17:		Line 18:

	== Modified attributes ==		== Modified attributes ==
	{\| class="darktable~~" style="float:right~~"		{\| class="darktable"
	! Attribute !! Used on...		! Attribute !! Used on...
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~type" \|\| Any clicks.		\| type \|\| Any clicks.
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~*type1" \|\| Any left click.		\| *type1 \|\| Any left click.
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~type1" \|\| Unmodified left click.		\| type1 \|\| Unmodified left click.
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~shift-type2" \|\| Shift+right click. (But not Alt+Shift+right click)		\| shift-type2 \|\| Shift+right click. (But not Alt+Shift+right click)
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~shift-type*" \|\| Shift+any button click.		\| shift-type* \|\| Shift+any button click.
	\|-		\|-
	\| ~~style="padding-right: 1em"\| "~~alt-ctrl-shift-type*" \|\| Alt+Control+Shift+any button click.		\| alt-ctrl-shift-type* \|\| Alt+Control+Shift+any button click.
	\|-		\|-
	~~\| style="padding-right: 1em"~~\| <~~span style="color:red"~~>"ctrl-alt-shift-type*"</~~span~~> \|\| Invalid, as modifiers are in the wrong order.		\| <s>ctrl-alt-shift-type*</s> \|\| Invalid, as modifiers are in the wrong order.
	\|}		\|}

	Some attribute may change value based on whether a particular combination of modifier keys is held down and/or a particular button is being clicked. Those attributes are typically called modified attributes, and are resolved by the SecureButton_GetModifiedAttribute function.		Some attribute may change value based on whether a particular combination of modifier keys is held down and/or a particular button is being clicked. Those attributes are typically called modified attributes, and are resolved by the SecureButton_GetModifiedAttribute function.

WoWWiki>NightnessDev at 01:41, 4 December 2018

2018-12-04T01:41:53Z

← Older revision		Revision as of 01:41, 4 December 2018
Line 1:		Line 1:
	{{uitech}}		{{uitech}}The '''SecureActionButtonTemplate''' was introduced in [[Patch 2.0]] to allow addons to perform protected actions -- casting spells, executing macros, etc -- by specifying button behavior via its attributes.
	The '''SecureActionButtonTemplate''' was introduced in [[Patch 2.0]] to allow addons to perform protected actions -- casting spells, executing macros, etc -- by specifying button behavior via its attributes.

	== Creating a SecureActionButton ==		== Creating a SecureActionButton ==
Line 70:		Line 69:

	== Action Types ==		== Action Types ==
	The action the SecureActionButtonTemplate-inheriting frame actually performs is dependent on the value of its ''modified'' type attribute, and possibly additional attributes specific to a type.		The action the SecureActionButtonTemplate-inheriting frame actually performs is dependent on the value of its ''modified'' type attribute, and possibly additional attributes specific to a type.

	The table below lists all valid type values and the attributes they use to perform their actions. All relevant attributes can be modified as previously described; and, to the extent possible, all types respect the "unit" attribute for targeting. Generally, variable names are used to refer to the value of the modified attribute sharing their name.		The table below lists all valid type values and the attributes they use to perform their actions. All relevant attributes can be modified as previously described; and, to the extent possible, all types respect the "unit" attribute for targeting. Generally, variable names are used to refer to the value of the modified attribute sharing their name.

	{\| class="darktable"		{\| class="darktable"
	\|+ SecureActionButtonTemplate "type" attributes		\|+SecureActionButtonTemplate "type" attributes
			\|-
	! style="width: 8em" \| Type		! style="width: 8em" \| Type
	! style="width: 8em" \| Used attributes		! style="width: 8em" \| Used attributes
Line 83:		Line 83:
	\| valign="top" \| "action"		\| valign="top" \| "action"
	\| Switches the current action bar depending on the value of the "action" attribute:		\| Switches the current action bar depending on the value of the "action" attribute:

	* A number: switches to a the bar specified by the number.		* A number: switches to a the bar specified by the number.
	* "increment" or "decrement": move one bar up/down.		* "increment" or "decrement": move one bar up/down.
Line 91:		Line 92:
	\| Performs an action specified by the "action" attribute (a number).<br />		\| Performs an action specified by the "action" attribute (a number).<br />
	If the button:GetID() > 0, paging behavior is supported; see the ActionButton_CalculateAction FrameXML function.		If the button:GetID() > 0, paging behavior is supported; see the ActionButton_CalculateAction FrameXML function.
	\|-
	~~\| valign="top" \| "pet"~~
	~~\| valign="top" \| "unit", "action"~~
	~~\| Calls {{api\|CastPetAction}}(action, unit);~~
	\|-		\|-
	\| valign="top" \| "pet"		\| valign="top" \| "pet"
Line 111:		Line 108:
	\|-		\|-
	\| valign="top" \| "macro"		\| valign="top" \| "macro"
	\| valign="top" \| "macro" OR<br/>"macrotext"		\| valign="top" \| "macro" OR<br />"macrotext"
	\| valign="top" \| If "macro" attribute is specified, calls {{api\|RunMacro}}(macro, button); otherwise, {{api\|RunMacroText}}(macrotext, button);		\| valign="top" \| If "macro" attribute is specified, calls {{api\|RunMacro}}(macro, button); otherwise, {{api\|RunMacroText}}(macrotext, button);
	\|-		\|-
	\| valign="top" \| "cancelaura"		\| valign="top" \| "cancelaura"
	\| valign="top" \| "unit"<br />"index" OR<br />"spell"[, "rank"]		\| valign="top" \| "unit"<br />"index" OR<br />"spell"[, "rank"]
	\| Calls either {{api\|CancelUnitBuff}}(unit, index) or CancelUnitBuff(unit, spell, rank). The first version		\| Calls either {{api\|CancelUnitBuff}}(unit, index) or CancelUnitBuff(unit, spell, rank). The first version
	'''Note''': the value of the "index" attribute must resolve to nil/false for the "spell", "rank" attributes to be considered.		'''Note''': the value of the "index" attribute must resolve to nil/false for the "spell", "rank" attributes to be considered.
	\|-		\|-
Line 137:		Line 134:
	\| valign="top" \| "action", "unit"		\| valign="top" \| "action", "unit"
	\| Performs a main assist status on the unit based on the value of the "action" attribute:		\| Performs a main assist status on the unit based on the value of the "action" attribute:

	* nil or "set": the unit is assigned main assist status. ({{api\|SetPartyAssignment}})		* nil or "set": the unit is assigned main assist status. ({{api\|SetPartyAssignment}})
	* "clear": the unit is stripped main assist status. ({{api\|ClearPartyAssignment}})		* "clear": the unit is stripped main assist status. ({{api\|ClearPartyAssignment}})
Line 150:		Line 148:
	\|-		\|-
	\| valign="top" \| "attribute"		\| valign="top" \| "attribute"
	\| valign="top" \| ["attribute-frame",]<br /> "attribute-name"<br /> "attribute-value"		\| valign="top" \| ["attribute-frame",]<br />"attribute-name"<br />"attribute-value"
	\| valign="top" \| Calls frame:SetAttribute(attributeName, attributeValue). If "attribute-frame" is not specified, the button itself is assumed.		\| valign="top" \| Calls frame:SetAttribute(attributeName, attributeValue). If "attribute-frame" is not specified, the button itself is assumed.
	\|-		\|-
Line 156:		Line 154:
	\| valign="top"\| "_''type''"		\| valign="top"\| "_''type''"
	\| Action depends on the value of the modified ("_" .. type) attribute, or rawget(button, type), in that order.		\| Action depends on the value of the modified ("_" .. type) attribute, or rawget(button, type), in that order.

	* If the value is a function, it is called with (self, unit, button, actionType) arguments		* If the value is a function, it is called with (self, unit, button, actionType) arguments
	* If the value is a string, a restricted snippet stored in the attribute specified by the value on the button is executed as if it was OnClick.		* If the value is a string, a restricted snippet stored in the attribute specified by the value on the button is executed as if it was OnClick.
Line 172:		Line 171:
	! Function		! Function
	\|-		\|-
	\| valign="top" \| "downbutton"		\| valign="top" \| "downbutton"
	\| valign="top" \| Any string		\| valign="top" \| Any string
	\| Remaps the mouse button if this is a "down" click. This transformation is applied before all others.		\| Remaps the mouse button if this is a "down" click. This transformation is applied before all others.
	\|-		\|-
	\| valign="top" \| "unitsuffix"		\| valign="top" \| "unitsuffix"
	\| valign="top" \| "pet", "target", etc.		\| valign="top" \| "pet", "target", etc.
	\| Appends the attribute's value to the "unit" attribute value when resolving units.		\| Appends the attribute's value to the "unit" attribute value when resolving units.
Line 183:		Line 182:
	\| valign="top" \| true, false		\| valign="top" \| true, false
	\| When the unit's owner is in a vehicle, remap the pet to its owner, and its owner to its pet (the vehicle). Based on the original unit:		\| When the unit's owner is in a vehicle, remap the pet to its owner, and its owner to its pet (the vehicle). Based on the original unit:

	* If it was a pet unit ("raidpetX", "pet", etc), and owner is in a vehicle, remap to owner.		* If it was a pet unit ("raidpetX", "pet", etc), and owner is in a vehicle, remap to owner.
	* If it did not contain "target", or "allowVehicleTarget" attribute is set to true, remap the original unit to its pet.		* If it did not contain "target", or "allowVehicleTarget" attribute is set to true, remap the original unit to its pet.
	\|-		\|-
	\| valign="top" \| "allowVehicleTarget"		\| valign="top" \| "allowVehicleTarget"
	\| valign="top" \| true, false		\| valign="top" \| true, false
	\| If true, allows "toggleForVehicle" to remap units like "party1target" to "partypet1target".		\| If true, allows "toggleForVehicle" to remap units like "party1target" to "partypet1target".
	\|-		\|-
	\| valign="top" \| "checkselfcast"		\| valign="top" \| "checkselfcast"
	\| valign="top" \| true, false		\| valign="top" \| true, false
	\| If true, and the SELFCAST modifier is held down, resolves the unit to "player".		\| If true, and the SELFCAST modifier is held down, resolves the unit to "player".
	\|-		\|-
	\| valign="top" \| "checkfocuscast"		\| valign="top" \| "checkfocuscast"
	\| valign="top" \| true, false		\| valign="top" \| true, false
	\| If true, and the FOCUSCAST modifier is held down, resolves the unit to "focus".		\| If true, and the FOCUSCAST modifier is held down, resolves the unit to "focus".

75.111.71.11: Added warning due to broken lua code

2015-11-13T05:18:06Z

Added warning due to broken lua code

← Older revision		Revision as of 05:18, 13 November 2015
Line 12:		Line 12:
	</Attributes>		</Attributes>
	</Button>		</Button>
	'''Using Lua''':		'''Using Lua''': (Warning: the following code does nothing)
	local btn = CreateFrame("Button", "myButton", UIParent, "SecureActionButtonTemplate");		local btn = CreateFrame("Button", "myButton", UIParent, "SecureActionButtonTemplate");
	btn:SetAttribute("type", "action");		btn:SetAttribute("type", "action");

WoWWiki>Starlightblunder: /* Other attributes */ width

2009-06-03T10:48:55Z

Other attributes: width

Show changes

WoWWiki>Hazara Khan: /* Frame Attribute Modifications */

2009-01-30T19:50:32Z

Frame Attribute Modifications

← Older revision		Revision as of 19:50, 30 January 2009
Line 296:		Line 296:
	The "modified attribute" takes the form of: modifier-name-button. The modifier is one of "alt-", "ctrl-", "shift-", or combination of them in '''''this''''' order, and the button is a number from 1 through 5 or hyphen followed custom button name mapped through some means.		The "modified attribute" takes the form of: modifier-name-button. The modifier is one of "alt-", "ctrl-", "shift-", or combination of them in '''''this''''' order, and the button is a number from 1 through 5 or hyphen followed custom button name mapped through some means.
	* Note that modifiers have to appear in order "alt-ctrl-shift-" to function, if you mess the order that attribute will only consume memory for nothing.		* Note that modifiers have to appear in order "alt-ctrl-shift-" to function, if you mess the order that attribute will only consume memory for nothing.
			* Note also that, to have your frame respond to different clicks
			self:RegisterForClicks("AnyUp")

	For example, you could set an action that is used for unmodified left click like this:		For example, you could set an action that is used for unmodified left click like this:

WoWWiki>KirkBot: Typo fixing, typos fixed: targetting → targeting using AWB

2008-08-07T21:44:01Z

Typo fixing, typos fixed: targetting → targeting using AWB

← Older revision		Revision as of 21:44, 7 August 2008
Line 44:		Line 44:
	frame:SetAttribute("type1", "actionbar") -- Sets this frame's left click type to "actionbar"		frame:SetAttribute("type1", "actionbar") -- Sets this frame's left click type to "actionbar"
	frame:SetAttribute("action1", "increment") -- Causes this frame to increment the action bar index when left clicked		frame:SetAttribute("action1", "increment") -- Causes this frame to increment the action bar index when left clicked
	-----		----

	===action===		===action===
Line 64:		Line 64:
	frame:SetAttribute("action1", 3) -- Causes this frame to use the action in your #3 action bar slot when left clicked		frame:SetAttribute("action1", 3) -- Causes this frame to use the action in your #3 action bar slot when left clicked
	frame:SetAttribute("shift-action1", 4) -- Causes this frame to use the action in your #4 action bar slot when shift-left clicked		frame:SetAttribute("shift-action1", 4) -- Causes this frame to use the action in your #4 action bar slot when shift-left clicked
	-----		----

	===pet===		===pet===
Line 83:		Line 83:
	frame:SetAttribute("action1", 3) -- Causes this frame to use the action in your pet's #3 bar slot when left clicked		frame:SetAttribute("action1", 3) -- Causes this frame to use the action in your pet's #3 bar slot when left clicked
	frame:SetAttribute("shift-action1", 4) -- Causes this frame to use the action in your pet's #4 action bar slot when shift-left clicked		frame:SetAttribute("shift-action1", 4) -- Causes this frame to use the action in your pet's #4 action bar slot when shift-left clicked
	-----		----

	===spell===		===spell===
Line 102:		Line 102:
	frame:SetAttribute("spell1", "Flash Heal")		frame:SetAttribute("spell1", "Flash Heal")
	frame:SetAttribute("shift-spell1", "Greater Heal")		frame:SetAttribute("shift-spell1", "Greater Heal")
	-----		----

	===item===		===item===
Line 138:		Line 138:
	Note that using items by bagslot will sell or bank them with the corresponding frames open. I.e. just as right-clicking items in bags does. Using items by name or itemstring on the other hand will never do that, just as placing them in an actionbar and clicking them that way won't.		Note that using items by bagslot will sell or bank them with the corresponding frames open. I.e. just as right-clicking items in bags does. Using items by name or itemstring on the other hand will never do that, just as placing them in an actionbar and clicking them that way won't.

	-----		----

	===macro===		===macro===
Line 159:		Line 159:

	frame:SetAttribute("type1", "macro")		frame:SetAttribute("type1", "macro")
	frame:SetAttribute("macrotext", "/party I am ~~targetting~~ %t")		frame:SetAttribute("macrotext", "/party I am targeting %t")
	-----		----

	===stop===		===stop===
Line 175:		Line 175:

	frame:SetAttribute("type", "stop")		frame:SetAttribute("type", "stop")
	-----		----

	===target===		===target===
Line 194:		Line 194:
	\|}		\|}
	frame:SetAttribute("type", "target")		frame:SetAttribute("type", "target")
	-----		----

	===target-item===		===target-item===
Line 202:		Line 202:
	'''Attributes:'''		'''Attributes:'''
	frame:SetAttribute("target-item", "itemName" or "[[itemString]]" or "[[itemLink]]") -- possibly itemid? not tested		frame:SetAttribute("target-item", "itemName" or "[[itemString]]" or "[[itemLink]]") -- possibly itemid? not tested
	-----		----

	===focus===		===focus===
Line 217:		Line 217:
	Clicking this frame will set your focus to this frame's specified ''unit''.		Clicking this frame will set your focus to this frame's specified ''unit''.
	frame:SetAttribute("type", "focus")		frame:SetAttribute("type", "focus")
	-----		----

	===assist===		===assist===
Line 232:		Line 232:
	Clicking this frame will cause you to target and start attacking the target of this button's unit.		Clicking this frame will cause you to target and start attacking the target of this button's unit.
	frame:SetAttribute("type", "assist")		frame:SetAttribute("type", "assist")
	-----		----

	===click===		===click===
Line 248:		Line 248:
	frame:SetAttribute("type", "click")		frame:SetAttribute("type", "click")
	frame:SetAttribute("clickbutton", myOtherButton)		frame:SetAttribute("clickbutton", myOtherButton)
	-----		----
	===attribute===		===attribute===
	Sets attribute for arbitrary frame.		Sets attribute for arbitrary frame.
Line 271:		Line 271:
	frame:SetAttribute("attribute-name","unit")		frame:SetAttribute("attribute-name","unit")
	frame:SetAttribute("attribute-value","focus")		frame:SetAttribute("attribute-value","focus")
	-----		----

	===menu===		===menu===

WoWWiki>Charibot: catfix

2008-07-07T18:38:00Z

catfix

← Older revision		Revision as of 18:38, 7 July 2008
Line 392:		Line 392:
	* Casts Renew when right-clicked if your target is friendly		* Casts Renew when right-clicked if your target is friendly

	[[Category:Interface ~~Customization~~]]		[[Category:Interface customization]]

WoWWiki>Mikk: /* target-item */ added

2008-05-20T06:48:19Z

target-item: added

← Older revision		Revision as of 06:48, 20 May 2008
Line 194:		Line 194:
	\|}		\|}
	frame:SetAttribute("type", "target")		frame:SetAttribute("type", "target")
			-----

			===target-item===
			Perform an action (e.g. spell=disenchant) on an item in your bags
			<br />

			'''Attributes:'''
			frame:SetAttribute("target-item", "itemName" or "[[itemString]]" or "[[itemLink]]") -- possibly itemid? not tested
	-----		-----

WoWWiki>Watchout: /* menu */ using the .showmenu table key does not work, use the .menu key instead

2008-03-25T01:54:17Z

menu: using the .showmenu table key does not work, use the .menu key instead

← Older revision		Revision as of 01:54, 25 March 2008
Line 272:		Line 272:
	{\| border="1" style="border-collapse: collapse;" cellpadding="4"		{\| border="1" style="border-collapse: collapse;" cellpadding="4"
	\|-----		\|-----
	\| Requires that the button have a "~~showmenu~~" property set. This property should be a function that takes a unit as a parameter.		\| Requires that the button have a "menu" property set. This property should be a function that takes a unit as a parameter.
	\|}		\|}

	Clicking this button will call :Click() on myOtherButton.		Clicking this button will call :Click() on myOtherButton.
	frame:SetAttribute("type", "menu")		frame:SetAttribute("type", "menu")
	frame.~~showmenu~~ = some_function_that_shows_a_menu		frame.menu = some_function_that_shows_a_menu
	----		----