Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:09Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Interface}}
Returns the texture and texture coordinates for an icon id.

<pre>
texture, x, y, disabledTexture = GetIconData(iconId)
</pre>

== Arguments ==
;iconId : <code>number</code> – Icon id, as found in fields such as <code>iconNum</code> of ability, item and buff data.

== Returns ==
;texture : <code>string</code> – Name of the texture that holds the icon.
;x, y : <code>number</code> – Position of the icon inside that texture.
;disabledTexture : <code>string</code> – Name of a texture with the disabled (greyed) version of the icon, or an empty string if there is none.

== Details ==
* The id is converted to an integer.
* If the id is not in the client's icon table, the data of the client's default icon entry is returned instead. There is no error for an unknown id.
* All four values are returned on every successful call.
* <code>texture</code> and <code>disabledTexture</code> are plain strings, not wide strings. <code>easystem_utils/source/iconbuttonutils.lua</code> compares <code>disabledTexture</code> with <code>L""</code>; <code>ea_actionbars/source/actionbutton.lua</code> compares it with <code>""</code>.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/iconbuttonutils.lua</code>:
<pre>
local texture, x, y, disabledTexture = GetIconData( iconId )

-- Set the Normal Texture
DynamicImageSetTexture( iconButtonName.."Icon", texture, x, y )
</pre>

From <code>ea_actionbars/source/actionbutton.lua</code>:
<pre>
texture, x, y, disabledTexture = GetIconData (iconNum)

if (iconType == USE_DISABLED_ICON)
then
if (disabledTexture ~= "")
then
texture = disabledTexture
...
</pre>

== See also ==
* [[API:DynamicImageSetTexture|DynamicImageSetTexture]]
* [[API:GetMapIconData|GetMapIconData]]

API:GetIconData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)