WoW:API UseAction - Revision history

Move page script: Move page script moved page API UseAction to WoW:API UseAction without leaving a redirect

2023-08-15T04:47:50Z

Move page script moved page API UseAction to API UseAction without leaving a redirect

← Older revision

Revision as of 04:47, 15 August 2023

Bear at 19:47, 25 September 2013

2013-09-25T19:47:48Z

← Older revision		Revision as of 19:47, 25 September 2013
Line 1:		Line 1:
	{{wowapi}} ~~__NOTOC__~~		{{wowapi}}
	{{protectedapi\|2.0.1\|For alternatives, try [[~~API_SecureTemplates~~\|~~Secure Templates~~]] or the new [[Conditional slash commands]].}}		{{protectedapi\|2.0.1\|For alternatives, try [[API SecureTemplates\|SecureTemplates]] or the new [[Conditional slash commands]].}}

	Perform the specified action.		Perform the specified action.

	UseAction(slot[, checkCursor[, onSelf]])		UseAction(slot[, checkCursor[, onSelf]])
Line 8:		Line 8:
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	:;slot : Numeric - The action [[ActionSlot\|slot]] to use.		:;slot
	:;checkCursor : Flag <small>''(optional)''</small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:: Numeric - The action [[ActionSlot\|slot]] to use.
	:;onSelf : Flag <small>''(optional)''</small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.		:;checkCursor
			:: Flag <small>''(optional)''</small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
			:;onSelf
			:: Flag <small>''(optional)''</small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

	=== Returns ===		=== Returns ===

WoWWiki>VoidvectorBot: Robot: converting/fixing HTML

2007-01-20T09:37:26Z

Robot: converting/fixing HTML

← Older revision		Revision as of 09:37, 20 January 2007
Line 9:		Line 9:
	=== Arguments ===		=== Arguments ===
	:;slot : Numeric - The action [[ActionSlot\|slot]] to use.		:;slot : Numeric - The action [[ActionSlot\|slot]] to use.
	:;checkCursor : Flag <small>~~<i>~~(optional)~~</i>~~</small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:;checkCursor : Flag <small>''(optional)''</small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
	:;onSelf : Flag <small>~~<i>~~(optional)~~</i>~~</small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.		:;onSelf : Flag <small>''(optional)''</small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

	=== Returns ===		=== Returns ===

WoWWiki>Starlightblunder: 2.0.1 protected note

2006-12-16T11:14:04Z

2.0.1 protected note

← Older revision		Revision as of 11:14, 16 December 2006
Line 1:		Line 1:
	{{wowapi}} __NOTOC__		{{wowapi}} __NOTOC__
			{{protectedapi\|2.0.1\|For alternatives, try [[API_SecureTemplates\|Secure Templates]] or the new [[Conditional slash commands]].}}

	Perform the specified action.		Perform the specified action.
Line 7:		Line 8:
	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===

	~~:(slot[, checkCursor[, onSelf]])~~

	:;slot : Numeric - The action [[ActionSlot\|slot]] to use.		:;slot : Numeric - The action [[ActionSlot\|slot]] to use.
	:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.

WoWWiki>Mikk: /* Details */

2006-08-13T14:15:31Z

Details

← Older revision		Revision as of 14:15, 13 August 2006
Line 9:		Line 9:

	:(slot[, checkCursor[, onSelf]])		:(slot[, checkCursor[, onSelf]])
	:;slot : Numeric - The action [[~~API TYPE~~ ActionSlot\|slot]] to use.
			:;slot : Numeric - The action [[ActionSlot\|slot]] to use.
	:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
	:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.		:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.
Line 29:		Line 30:
	== Details ==		== Details ==

	See [[~~API TYPE ActionSlot\|ActionSlot~~]] for more information on slot numbers and example code for listing available slots.		See the [[actionSlot]] API Type for more information on slot numbers and example code for listing available slots.

WoWWiki>DarkRyder: switched to new template, moved ActionSlot code to the ActionSlot page

2006-07-26T21:40:10Z

switched to new template, moved ActionSlot code to the ActionSlot page

← Older revision		Revision as of 21:40, 26 July 2006
Line 1:		Line 1:
	~~<center>'''UseAction''' - ''Documentation by [[User:Sarf\|Sarf]]''</center>~~		{{wowapi}} __NOTOC__

	Perform the specified action.		Perform the specified action.

	UseAction(slot [,checkCursor] [,onSelf])		UseAction(slot[, checkCursor[, onSelf]])

	== Parameters ==		== Parameters ==
	=== Arguments ===		=== Arguments ===
	~~:(slot [,checkCursor] [,onSelf])~~

			:(slot[, checkCursor[, onSelf]])
	:;slot : Numeric - The action [[API TYPE ActionSlot\|slot]] to use.		:;slot : Numeric - The action [[API TYPE ActionSlot\|slot]] to use.
	:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
	:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.		:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

	== ~~Details~~ ==		=== Returns ===
	: ~~Each button on your~~ action ~~bar has an ID. The first button id is 1, and so on. There are 6 action bars in all, thus~~ the ~~highest~~ action ~~bar is 72. With the addition of ver 1300~~, ~~Page 3 acts as the Right Action bar~~, ~~page 4 acts as the second Right action bar, page 5 acts as the Bottom Right bar, and page 6 acts as the Bottom Left bar.~~
			:''none''

			== Example ==

			action = 18 -- Change this to the slot number you want to activate
			UseAction(action, 0, 1)

			=== Result ===

	~~; Update 31~~-~~Dec~~-~~2005 : Action~~ bar ~~SlotID's have been seen as high as 120 and may go even higher. Druids are lucky enough~~ to ~~get extra action bars for some~~ of ~~their forms (Bear Form, Cat Form, but apparently not Aquatic Form~~ or ~~Travel Form)~~. ~~The following code enumerates the (/macro) name and texture for all assigned action bar slots:~~		-- Causes action bar slot #18 to be cast on the player, regardless
			-- of whether the cursor is currently "holding" an item or ability.

	~~function reportActionButtons()~~		== Details ==
	~~local lActionSlot~~ = 0
	~~for lActionSlot~~ = ~~1, 120 do~~
	~~local lActionText~~ = ~~GetActionText(lActionSlot)~~
	~~if not(lActionText) then lActionText~~ = ~~"" end~~
	~~local lActionTexture = GetActionTexture(lActionSlot)~~
	~~if (lActionText) and (lActionTexture) then~~
	~~local lMessage = lActionSlot..". "..lActionText~~
	~~lMessage = lMessage.." ["..lActionTexture.."]"~~
	~~DEFAULT_CHAT_FRAME:AddMessage(lMessage)~~
	~~end~~
	~~end~~
	~~end~~

	~~----~~		See [[API TYPE ActionSlot\|ActionSlot]] for more information on slot numbers and example code for listing available slots.
	~~__NOTOC__~~
	~~{{Template:WoW~~ API}}

WoWWiki>WoWWiki-Jebr: there are only 120 slots, if you try access anything higher it will fail.

2006-07-08T07:07:56Z

there are only 120 slots, if you try access anything higher it will fail.

← Older revision		Revision as of 07:07, 8 July 2006
Line 19:		Line 19:
	function reportActionButtons()		function reportActionButtons()
	local lActionSlot = 0		local lActionSlot = 0
	for lActionSlot = 1, ~~128~~ do		for lActionSlot = 1, 120 do
	local lActionText = GetActionText(lActionSlot)		local lActionText = GetActionText(lActionSlot)
	if not(lActionText) then lActionText = "" end		if not(lActionText) then lActionText = "" end

WoWWiki>Gello: New link to reference slot ids

2006-06-06T21:27:53Z

New link to reference slot ids

← Older revision		Revision as of 21:27, 6 June 2006
Line 8:		Line 8:
	:(slot [,checkCursor] [,onSelf])		:(slot [,checkCursor] [,onSelf])

	:;slot : Numeric - The action slot to use.		:;slot : Numeric - The action [[API TYPE ActionSlot\|slot]] to use.
	:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.		:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
	:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.		:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

WoWWiki>Xelepart: /* Arguments */

2006-05-26T16:27:16Z

Arguments

← Older revision		Revision as of 16:27, 26 May 2006
Line 9:		Line 9:

	:;slot : Numeric - The action slot to use.		:;slot : Numeric - The action slot to use.
	:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up.		:;checkCursor : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. I can confirm this. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one.
	:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target.		:;onSelf : Flag <small><i>(optional)</i></small> - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error.

	== Details ==		== Details ==

WoWWiki>Cerdor: Tweaked the example code so it would not cause an error on blank button slots.

2006-04-11T21:10:20Z

Tweaked the example code so it would not cause an error on blank button slots.

← Older revision		Revision as of 21:10, 11 April 2006
Line 23:		Line 23:
	if not(lActionText) then lActionText = "" end		if not(lActionText) then lActionText = "" end
	local lActionTexture = GetActionTexture(lActionSlot)		local lActionTexture = GetActionTexture(lActionSlot)
	if (lActionText) or (lActionTexture) then		if (lActionText) and (lActionTexture) then
	local lMessage = lActionSlot..". "..lActionText		local lMessage = lActionSlot..". "..lActionText
	lMessage = lMessage.." ["..lActionTexture.."]"		lMessage = lMessage.." ["..lActionTexture.."]"