WoW:API GameTooltip SetSpell: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Note for cata)
m (Confusion between SpellId and the id of the spell in the spell book. Renamed SpellId to SpellBookId for clarity)
Line 1: Line 1:
{{widgetmethod}}
{{widgetmethod}}
Shows the tooltip for the specified spell.
Shows the tooltip for the specified spell.
  GameTooltip:SetSpell(spellId, bookType);
  GameTooltip:SetSpell(spellBookId, bookType);
;''Arguments''
;''Arguments''
:(spellId, spellbookTabNum)
:
:;spellId: Number - the id of the spell on the tab
:;spellBookId: Number - the id of the spell on the tab from the spellbook - not the same as SpellId
:;bookType: String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").
:;bookType: String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").


Line 14: Line 14:


== Details ==
== Details ==
* Find the spellId as follows:
* Find the spellBookId as follows:


  local i = 1
  local i = 1

Revision as of 14:05, 16 October 2010

Widget API ← GameTooltip < SetSpell

Shows the tooltip for the specified spell.

GameTooltip:SetSpell(spellBookId, bookType);
Arguments
spellBookId
Number - the id of the spell on the tab from the spellbook - not the same as SpellId
bookType
String - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet").
Returns
unknown

Examples

GameTooltip:SetSpell(46, BOOKTYPE_SPELL)

Details

  • Find the spellBookId as follows:
local i = 1
while true do
   local spell, rank = GetSpellName(i, BOOKTYPE_SPELL)
   if (not spell) then
      break
   end
   if (rank) then
      spell = spell.." ("..rank..")"
   end
   DEFAULT_CHAT_FRAME:AddMessage(i..": "..spell)
   i = i + 1
end

Notes

This has been renamed to SetSpellBookItem in patch 4.0.1