Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:39Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Game}}
Returns the items the player has equipped, one table per equipment slot.

<pre>
equipment = GetEquipmentData()
</pre>

== Arguments ==
None.

== Returns ==
;equipment : <code>table</code> – Array of 20 [[API:GetInventoryItemData#Item data table|item data tables]], indexed by equipment slot from 1 to 20.

== Details ==
* The table always has 20 entries. An empty slot gets a blank item table (<code>id</code> 0, empty <code>name</code>).
* If there is no player object, or the Lua state is not available, the function returns nothing.
* A new table is built on every call. The stock UI caches it in <code>DataUtils.GetEquipmentData()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Player.equippedItemsDirty</code> is set.

== Errors ==
None.

== Example ==
From <code>easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetEquipmentData ()
if (GameData.Player.equippedItemsDirty)
then
GameData.Player.equippedItemsDirty = false
DataUtilsData.equippedItems = GetEquipmentData()
end

return DataUtilsData.equippedItems
end
</pre>

Comparing with the currently equipped item, from <code>easystem_tooltips/source/itemtooltips.lua</code>:
<pre>
local curItem = DataUtils.GetEquipmentData()[playerEquipSlot];
</pre>

== See also ==
* [[API:GetInventoryItemData|GetInventoryItemData]]
* [[API:GetQuestItemData|GetQuestItemData]]

API:GetEquipmentData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)