Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:03Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Hotbar}}
Returns the icon of the action in a hotbar slot.

<pre>
iconNum = GetHotbarIcon(slot)
</pre>

== Arguments ==
;slot : <code>number</code> – Hotbar slot, 1 to 132 (<code>GameData.HOTBAR_TOTAL_SLOT_COUNT</code>).

== Returns ==
;iconNum : <code>number</code> – Icon id for [[API:GetIconData|GetIconData]], or 0.

== Details ==
* The icon is looked up according to the action type: abilities (types 1 and 10) use the ability's icon, items (type 2) the item's icon, macros (type 4) the macro's icon, and types 7 and 9 their own data. Other types, empty slots and slots outside 1 to 132 give 0.
* A comment in <code>ea_actionbars/source/actionbutton.lua</code> notes that the icon can be 0 while item data is not yet on the client; the stock button then uses a cached icon.
* If there is no player object, or the Lua state is not available, the function returns nothing.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
From <code>ea_actionbars/source/actionbutton.lua</code>:
<pre>
local icon = GetHotbarIcon (slot)

if (icon > 0)
then
CacheData (actionType, actionId, "icon", icon)
elseif (icon == 0)
then
icon = GetCachedData (actionType, actionId, "icon") or 0
end
</pre>

== See also ==
* [[API:GetHotbarName|GetHotbarName]]
* [[API:GetHotbarData|GetHotbarData]]
* [[API:GetIconData|GetIconData]]

API:GetHotbarIcon - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)