WoW:API GetSpecializationInfo: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{wowapi}} Returns information about the player's specializations. local id, name, description, icon, background, role = GetSpecializationInfo(specIndex [, isInspect [, isPet...") |
m (Move page script moved page API GetSpecializationInfo to API GetSpecializationInfo without leaving a redirect) |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{wowapi}} | {{wowapi}} | ||
Returns information about the player's specializations. | Returns information about the player's specializations. | ||
local id, name, description, icon, background, role = GetSpecializationInfo(specIndex [, isInspect [, isPet]]) | local id, name, description, icon, background, role = GetSpecializationInfo(specIndex [, isInspect [, isPet [, ? [, genderCode]]]]) | ||
== Arguments == | == Arguments == | ||
| Line 7: | Line 7: | ||
;isInspect : Optional boolean - If true, query specialization information for the inspected unit. | ;isInspect : Optional boolean - If true, query specialization information for the inspected unit. | ||
;isPet : Optional boolean - If true, query specialization information for the player's pet. | ;isPet : Optional boolean - If true, query specialization information for the player's pet. | ||
;genderCode : Number - Index returned by {{Api|UnitSex}}(). | |||
== Returns == | == Returns == | ||
;id : Number - | ;id : Number - [[specializationID]]. | ||
;name : String - specialization name, e.g. "Balance". | ;name : String - specialization name, e.g. "Balance". | ||
;description : String - description of the specialization, e.g. "Can take on the form of a powerful Moonkin, balancing the power of Arcane and Nature magic to destroy enemies at a distance." | ;description : String - description of the specialization, e.g. "Can take on the form of a powerful Moonkin, balancing the power of Arcane and Nature magic to destroy enemies at a distance." | ||
| Line 17: | Line 18: | ||
== Details == | == Details == | ||
* Despite the argument names, this function does not appear to return valid information for inspected units. FrameXML uses {{api|GetInspectSpecialization}}("unit") to retrieve a specialization ID instead. | * Despite the argument names, this function does not appear to return valid information for inspected units. FrameXML uses {{api|GetInspectSpecialization}}("unit") to retrieve a specialization ID instead. | ||
** ''Warning: As of 2012/07/12, this seems to be quite often buggy. The return of GetInspectSpecialization() should be a number less than 500, but sometimes is far greater and not interpretable. FrameXML is therefore 'validating' the value by calling GetSpecializationRoleByID(), and only if that returns a non-nil value, it decodes the number with GetSpecializationInfoByID(). | |||
== Patch history == | == Patch history == | ||
Latest revision as of 04:46, 15 August 2023
← WoW API < GetSpecializationInfo
Returns information about the player's specializations.
local id, name, description, icon, background, role = GetSpecializationInfo(specIndex [, isInspect [, isPet [, ? [, genderCode]]]])
Arguments[edit]
- specIndex
- Number - Index of the specialization to query, ascending from 1 to GetNumSpecializations().
- isInspect
- Optional boolean - If true, query specialization information for the inspected unit.
- isPet
- Optional boolean - If true, query specialization information for the player's pet.
- genderCode
- Number - Index returned by UnitSex().
Returns[edit]
- id
- Number - specializationID.
- name
- String - specialization name, e.g. "Balance".
- description
- String - description of the specialization, e.g. "Can take on the form of a powerful Moonkin, balancing the power of Arcane and Nature magic to destroy enemies at a distance."
- icon
- String - Texture path to this specialization's icon.
- background
- String - Background texture name for this talent tree; prepend "Interface\TALENTFRAME\" to this value for a valid texture path.
- role
- String - This specialization's intended role in a party, one of "DAMAGER", "TANK", "HEALER".
Details[edit]
- Despite the argument names, this function does not appear to return valid information for inspected units. FrameXML uses GetInspectSpecialization("unit") to retrieve a specialization ID instead.
- Warning: As of 2012/07/12, this seems to be quite often buggy. The return of GetInspectSpecialization() should be a number less than 500, but sometimes is far greater and not interpretable. FrameXML is therefore 'validating' the value by calling GetSpecializationRoleByID(), and only if that returns a non-nil value, it decodes the number with GetSpecializationInfoByID().
Patch history[edit]
Template:Mists-inline <span style="" title="Patch 5.0.4">Patch 5.0.4</span> (patch date::28-August-2012): Replaced GetTalentTabInfo.