WoW:API GetGlyphSocketInfo: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Updated with new information)
(formatting, 3.1)
Line 1: Line 1:
{{wowapi}} __NOTOC__
{{wowapi}} __NOTOC__
Returns information on a glyph socket.
Returns information on a glyph socket.
enabled, glyphType, glyphSpellID, icon = GetGlyphSocketInfo(socketID[, talentGroup]);
==Arguments==
;socketID : Number - glyph [Glyph SocketID|socket index]] (1 to GetNumGlyphSockets() )
;talentGroup : Optional Number - (dual) specialization index (1 to {{api|GetNumTalentGroups}}(...)).
== Returns ==
;enabled: Boolean - 1 if available, nil if locked.
;glyphType : Number - GLYPHTYPE_MAJOR (1) or GLYPHTYPE_MINOR (2)
;glyphSpellID : Number - spell ID of socketted glyph, nil if no glyph is socketed.
;icon : String - Glyph rune texture path.


enabled, glyphType, glyphSpellID, icon = GetGlyphSocketInfo([[Glyph SocketID|SocketID]]);
== Parameters ==
=== Arguments ===
:;[[Glyph SocketID|SocketID]] : Integer - Socket number.
=== Returns ===
:;enabled: Boolean - 1 if available. '''nil''' if locked.
:;glyphType : Integer - GLYPHTYPE_MAJOR or GLYPHTYPE_MINOR (1 is Major, 2 is Minor)
:;glyphSpellID : Integer - '''SpellID''' of socketted glyph. '''nil''' if none.
:;icon : String - Rune icon path. (Not the same icon as returned by [[API GetSpellInfo | GetSpellInfo]])
== Examples ==
== Examples ==
The following code scans all the glyph sockets and prints out the status of each one.
The following code scans all the glyph sockets and prints out the status of each one.
Line 26: Line 28:
   end
   end
  end
  end
== Notes ==
== Notes ==
"AddOns/Blizzard_GlyphUI/Blizzard_GlyphUI.lua"
* {{api|GetSpellInfo}} can be used to translate glyphSpellID to a glyph name.
Passes '''glyphSpellID''' to [[API GetSpellInfo | GetSpellInfo]] to retrieve the glyph name.
* The talentGroup argument was added in [[Patch 3.1]].

Revision as of 23:35, 3 June 2009

← WoW API < GetGlyphSocketInfo

Returns information on a glyph socket. 

enabled, glyphType, glyphSpellID, icon = GetGlyphSocketInfo(socketID[, talentGroup]);

Arguments

socketID
Number - glyph [Glyph SocketID|socket index]] (1 to GetNumGlyphSockets() )
talentGroup
Optional Number - (dual) specialization index (1 to GetNumTalentGroups(...)).

Returns

enabled
Boolean - 1 if available, nil if locked.
glyphType
Number - GLYPHTYPE_MAJOR (1) or GLYPHTYPE_MINOR (2)
glyphSpellID
Number - spell ID of socketted glyph, nil if no glyph is socketed.
icon
String - Glyph rune texture path.

Examples

The following code scans all the glyph sockets and prints out the status of each one. 

for i = 1, NUM_GLYPH_SLOTS do
 local enabled, glyphType, glyphSpellID, icon = GetGlyphSocketInfo(i);
 if ( enabled ) then
  local link = GetGlyphLink(i);-- Retrieves the Glyph's link (nil of no glyph in Socket);
  if ( link ) then
   DEFAULT_CHAT_FRAME:AddMessage("Glyph Socket "..i.." contains "..link);
  else
   DEFAULT_CHAT_FRAME:AddMessage("Glyph Socket "..i.." is unlocked and empty!");
  end
 else
  DEFAULT_CHAT_FRAME:AddMessage("Glyph Socket "..i.." is locked!");
 end
end

Notes

  • GetSpellInfo can be used to translate glyphSpellID to a glyph name.
  • The talentGroup argument was added in Patch 3.1.
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetGlyphSocketInfo&oldid=15540"