Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:29Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Returns the items in the player's currency backpack.

<pre>
items = GetCurrencyItemData()
</pre>

== Arguments ==
None.

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

== Details ==
* The table always has 32 entries, whatever the size of the player's currency backpack. Empty slots have an item table with default values (<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.GetCurrencyItems()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Player.currencyItemsDirty</code> is set.

== Errors ==
None.

== Example ==
From <code>default/easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetCurrencyItems()
if (GameData.Player.currencyItemsDirty)
then
GameData.Player.currencyItemsDirty = false
DataUtilsData.currencyItems = GetCurrencyItemData()
end

return DataUtilsData.currencyItems
end
</pre>

== See also ==
* [[API:GetCraftingItemData|GetCraftingItemData]]
* [[API:GetInventoryItemData|GetInventoryItemData]]
* [[API:GetSingleItem|GetSingleItem]]

API:GetCurrencyItemData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)