WoW:API GetTalentTabInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Add 2.3 inspect option.)
(add pet info for 3.0.2)
Line 2: Line 2:
Returns the information of the talent tab (tree)
Returns the information of the talent tab (tree)


  ''name, iconTexture, pointsSpent, background'' = GetTalentTabInfo( ''tabIndex'' [,''inspect''] );
  ''name, iconTexture, pointsSpent, background'' = GetTalentTabInfo( ''tabIndex'' [[,''inspect''] [,''isPet'']] );


----
----
Line 10: Line 10:


:;inspect : [[Boolean]] - If true returns the information for the inspected unit instead of  the player. New with 2.3.
:;inspect : [[Boolean]] - If true returns the information for the inspected unit instead of  the player. New with 2.3.
:;isPet : [[Boolean]] - If true then the current pet's talents are examined instead of a player. New with 3.0.2.


----
----
Line 30: Line 32:


;''Results'' : Displays the tabIndex number for each tab followed by the name of the tab.
;''Results'' : Displays the tabIndex number for each tab followed by the name of the tab.
----
;''Notes''
Passing a true value for ''isPet'' should only happen if the player is a hunter and there is a pet active.

Revision as of 15:56, 10 March 2009

WoW API < GetTalentTabInfo

Returns the information of the talent tab (tree)

name, iconTexture, pointsSpent, background = GetTalentTabInfo( tabIndex [[,inspect] [,isPet]] );

Arguments
tabIndex
Integer - Specifies which tab (tree) to identify.
inspect
Boolean - If true returns the information for the inspected unit instead of the player. New with 2.3.
isPet
Boolean - If true then the current pet's talents are examined instead of a player. New with 3.0.2.

Returns
name
String - The name of that tab.
iconTexture
String - Path and file name of tab icon.
pointsSpent
Integer - Number of points put into that tab.
background
String - File name of background image.

Example
local i = 1 
while i <= GetNumTalentTabs() do 
	local numTalents = GetNumTalents(i) 
       DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. GetTalentTabInfo(i) .. ' ' )
       i = i+1
end
Results
Displays the tabIndex number for each tab followed by the name of the tab.

Notes

Passing a true value for isPet should only happen if the player is a hunter and there is a pet active.