Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:49:05Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Hotbar}}
Puts an action into a hotbar slot, or clears the slot.

<pre>
SetHotbarData(slot, actionType, actionId)
</pre>

== Arguments ==
;slot : <code>number</code> – Hotbar slot, 1 to 132 (<code>GameData.HOTBAR_TOTAL_SLOT_COUNT</code>). A value of 0 or less places the action in the first empty slot; the stock UI uses -1.
;actionType : <code>number</code> – Type of the action, a <code>GameData.PlayerActions</code> value. 0 together with <code>actionId</code> 0 clears the slot.
;actionId : <code>number</code> – Id of the action (ability id, item id, macro slot, …).

== Returns ==
Nothing.

== Details ==
* Before writing, the client checks the slot and the ability against the player's hotbar state and does nothing if the check fails.
* If the slot already holds the same action, nothing changes.
* When the slot changes, the client sends the change to the server for slots that the server stores, and notifies the UI for every hotbar slot that shows this entry.
* If no slot is empty when <code>slot</code> is 0 or less, nothing is stored.
* For a slot above 132 the error below is logged (not raised as a Lua error) and nothing changes.

== Errors ==
* <code>Error in function call 'SetHotbarData': slot must be less than GameData.HOTBAR_TOTAL_SLOT_COUNT.</code> (logged)
* The generic ''Invalid Parameters'' message when an argument is not a number.

== Example ==
Placing an ability in the first free slot, from <code>ea_abilitieswindow/source/abilitieswindow.lua</code>:
<pre>
SetHotbarData( -1, GameData.PlayerActions.DO_ABILITY, abilityData.id )
</pre>

Clearing a slot, from <code>ea_actionbars/source/actionbutton.lua</code>:
<pre>
SetHotbarData (self:GetSlot (), 0, 0)
</pre>

== See also ==
* [[API:GetHotbarData|GetHotbarData]]
* [[API:SetMoraleBarData|SetMoraleBarData]]

API:SetHotbarData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)