Changes: API GameTooltip SetAction

Revision as of 01:06, 12 April 2005

GameTooltip:SetAction -Documentation by Esselte-

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, getglobal("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

@@ Line 29: / Line 29: @@
 ;''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. The bonus bars that appear for the warrior's stances, the 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. Note that for accessing the pet bar or aura bar you need to use [[API SetPetAction|SetPetAction]] or [[API SetShapeshift|SetShapeshift]].
+: 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 [[API SetPetAction|SetPetAction]] or [[API SetShapeshift|SetShapeshift]].
-: Beware of using, for example, getglobal("ActionButton1"):GetID(); This would return 1, no matter what page your action bar is on. The WoW variable CURRENT_ACTIONBAR_PAGE may be of use to you if you want to do something like this.
+: Beware of using, for example, getglobal("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).
 ----