WoW:API GetTalentTabInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(add pet info for 3.0.2)
(italics in code)
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''] [,''isPet'']] );
  name, iconTexture, pointsSpent, background, previewPointsSpent = GetTalentTabInfo(tabIndex[, inspect[, isPet]][, talentGroup])


----
==Arguments==
;''Arguments''
;tabIndex : Number - 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.
;talentGroup : Number - Optionally specifies which talent group (dual spec) to query.


:;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.
==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.
;previewPointsSpent : Number - Points spent in tab.


:;isPet : [[Boolean]] - If true then the current pet's talents are examined instead of a player. New with 3.0.2.
==Example==
 
The following code displays the tabIndex number for each tab followed by the name of the tab.
----
  for i = 1, GetNumTalentTabs() do
;''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) .. ' ' )
         DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. GetTalentTabInfo(i) .. ' ' )
        i = i+1
  end
  end


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

Revision as of 17:57, 19 December 2009

← WoW API < GetTalentTabInfo

Returns the information of the talent tab (tree) 

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

Arguments

tabIndex
Number - 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.
talentGroup
Number - Optionally specifies which talent group (dual spec) to query.


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.
previewPointsSpent
Number - Points spent in tab.

Example

The following code displays the tabIndex number for each tab followed by the name of the tab. 

for i = 1, GetNumTalentTabs() do
       DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. GetTalentTabInfo(i) .. ' ' )
end

Notes

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

Retrieved from "https://addonstudio.org/mw1/index.php?title=WoW:API_GetTalentTabInfo&oldid=11477"