WoW:API GameTooltip SetAction: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GameTooltip SetAction to API GameTooltip SetAction without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''GameTooltip:SetAction''' ''-Documentation by [[User:Esselte|Esselte]]-''</center>
{{widgetmethod}}


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
Line 32: Line 32:


: Beware of using, for example, ActionButton1:GetID(); This would return 1, no matter what page your action bar is on. The WoW function CURRENT_ACTIONBAR_PAGE may be of use to you if you want to do something like this, or if you have the button object already, ActionButton_GetPagedID(button).
: Beware of using, for example, ActionButton1:GetID(); This would return 1, no matter what page your action bar is on. The WoW function CURRENT_ACTIONBAR_PAGE may be of use to you if you want to do something like this, or if you have the button object already, ActionButton_GetPagedID(button).
----
{{Template:WoW API}}
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[Category:API Frame Functions|SetAction]]

Latest revision as of 04:45, 15 August 2023

Widget API ← GameTooltip < SetAction

GameTooltip:SetAction(slot);

Shows the tooltip for the specified action button.


Arguments
(slot)
slot
integer - id of the action button to load the tooltip for.

Returns
The function returns nothing, but the text in the displayed tooltip can be accessed with GameTooltipTextLeftN:GetText() and GameTooltipTextRightN:GetText(), where N is the line number.

Example
GameTooltip:SetAction(1);

Details
The term 'slot' is a bit misleading... it's really the id of the action button, where 1..12 are the first page, 13..24 are the second page, and so on up to 72 for the normally accessible pages 1-6. The bonus bars that appear for a warrior's stances, a druid's shapeshifts, and when a rogue is stealthed take up higher numbered ids, and some addons make use of otherwise unused ids as well (up to a maximum ID of 120). Note that for accessing the pet bar or aura bar you need to use SetPetAction or SetShapeshift.
Beware of using, for example, ActionButton1:GetID(); This would return 1, no matter what page your action bar is on. The WoW function CURRENT_ACTIONBAR_PAGE may be of use to you if you want to do something like this, or if you have the button object already, ActionButton_GetPagedID(button).