WoW:API GetMacroIconInfo: Difference between revisions

Revision as of 15:30, 29 December 2006

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

Return information for a macro icon.

iconTexture = GetMacroIconInfo(iconIndex)

iconIndex: Integer - The Index of the macro icon (from 1 to GetNumMacroIcons()).

local numIcons = GetNumMacroIcons();
local iconTexture = GetMacroIconInfo(1);
DEFAULT_CHAT_FRAME:AddMessage(iconTexture);

Displays Interface\Icons\INV_Misc_QuestionMark in the default chat frame.

You need to call GetNumMacroIcons() at least once before calling GetMacroIconInfo(), or the function will only return empty strings.

@@ Line 1: / Line 1: @@
-<center>'''GetMacroIconInfo'''</center>
+{{wowapi}} __NOTOC__
 Return information for a macro icon.
+  iconTexture = GetMacroIconInfo(iconIndex)
-  Returns iconTexture = GetMacroIconInfo(index)
+==Parameters==
-== Arguments ==
+===Arguments===
-:(index)
+:;iconIndex : Integer - The Index of the macro icon (from 1 to [[API_GetNumMacroIcons|GetNumMacroIcons()]]).
+===Returns===
-:;Index: Numeric - The Index of the macro icon (not the data returned by GetMacroInfo).
+:;iconTexture : String - The path of the texture without extention
-== Returns ==
-:;Texture
-;''Texture''
-:The path of the texture without extention
 == Example ==
-  local Texture = GetMacroIconInfo(1)
+  local numIcons = GetNumMacroIcons();
+ local iconTexture = GetMacroIconInfo(1);
+ DEFAULT_CHAT_FRAME:AddMessage(iconTexture);
-{{template:WoW API}}
+===Result===
+Displays ''Interface\Icons\INV_Misc_QuestionMark'' in the default chat frame.
+==Notes==
+You need to call [[API_GetNumMacroIcons|GetNumMacroIcons()]] at least once before calling GetMacroIconInfo(), or the function will only return empty strings.