WoW:API GetTalentTabInfo: Difference between revisions
Jump to navigation
Jump to search
m (→Notes) |
(added id, description, isUnlocked return values) |
||
| Line 2: | Line 2: | ||
Returns the information of the talent tab (tree) | Returns the information of the talent tab (tree) | ||
name, iconTexture, pointsSpent, background, previewPointsSpent = GetTalentTabInfo(tabIndex[, inspect[, isPet]][, talentGroup]) | id, name, description, iconTexture, pointsSpent, background, previewPointsSpent, isUnlocked = GetTalentTabInfo(tabIndex[, inspect[, isPet]][, talentGroup]) | ||
==Arguments== | ==Arguments== | ||
| Line 12: | Line 12: | ||
==Returns == | ==Returns == | ||
;id : Number - The id of that tab. | |||
;name : String - The name of that tab. | ;name : String - The name of that tab. | ||
;description : String - The localized summary of that tab. | |||
;iconTexture : String - Path and file name of tab icon. | ;iconTexture : String - Path and file name of tab icon. | ||
;pointsSpent : Integer - Number of points put into that tab. | ;pointsSpent : Integer - Number of points put into that tab. | ||
;background : String - File name of background image. | ;background : String - File name of background image. | ||
;previewPointsSpent : Number - Points spent in tab. | ;previewPointsSpent : Number - Points spent in tab. | ||
;isUnlocked : Boolean - Whether the player has access to put points in that tab. | |||
==Example== | ==Example== | ||
The following code displays the tabIndex number for each tab followed by the name of the tab. | The following code displays the tabIndex number for each tab followed by the name of the tab. | ||
for i = 1, GetNumTalentTabs() do | for i = 1, GetNumTalentTabs() do | ||
DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. | local _, name = GetTalentTabInfo(i) | ||
DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. name .. ' ' ) | |||
end | end | ||
| Line 30: | Line 34: | ||
**You're currently inspecting the unit and pass ''true'' as the second argument. In other words, the inspect frame is open and you have a target. | **You're currently inspecting the unit and pass ''true'' as the second argument. In other words, the inspect frame is open and you have a target. | ||
**You're calling {{api|NotifyInspect}}([[UnitId|unit]]), are waiting for [[Events/I#INSPECT_TALENT_READY|INSPECT_TALENT_READY]] to fire, and are passing ''true'' as the second argument. After the event fires, the client will have the information you desire. | **You're calling {{api|NotifyInspect}}([[UnitId|unit]]), are waiting for [[Events/I#INSPECT_TALENT_READY|INSPECT_TALENT_READY]] to fire, and are passing ''true'' as the second argument. After the event fires, the client will have the information you desire. | ||
*Return values ''id'', ''description'', and ''isUnlocked'' were added in [[Patch 4.0.1]]. | |||
Revision as of 00:46, 18 October 2010
Returns the information of the talent tab (tree)
id, name, description, iconTexture, pointsSpent, background, previewPointsSpent, isUnlocked = 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
- id
- Number - The id of that tab.
- name
- String - The name of that tab.
- description
- String - The localized summary 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.
- isUnlocked
- Boolean - Whether the player has access to put points in that tab.
Example
The following code displays the tabIndex number for each tab followed by the name of the tab.
for i = 1, GetNumTalentTabs() do
local _, name = GetTalentTabInfo(i)
DEFAULT_CHAT_FRAME:AddMessage( i .. ' ' .. name .. ' ' )
end
Notes
- Passing a true value for isPet should only work if the player is a hunter and has a pet active.
- In order for this function to return any useful information one of the following must occur:
- You're using it to get information regarding your player's current spec. In which case, you will not be passing the second argument. The client already knows everything it needs to know about you, so you don't need to inspect yourself.
- You're currently inspecting the unit and pass true as the second argument. In other words, the inspect frame is open and you have a target.
- You're calling NotifyInspect(unit), are waiting for INSPECT_TALENT_READY to fire, and are passing true as the second argument. After the event fires, the client will have the information you desire.
- Return values id, description, and isUnlocked were added in Patch 4.0.1.