Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:43:02Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Returns the items in the player's bank, one table per bank slot.

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

== Arguments ==
None.

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

== Details ==
* There is one entry for every bank slot the player has, including empty slots. An empty slot has an item table with default values (<code>id</code> 0, empty <code>name</code>).
* If the Lua state is not available, the function returns nothing. Unlike the other item getters, it does not check for a player object before reading the bank size, so only call it while the player is in the world.
* A new table is built on every call. The stock UI caches it in <code>DataUtils.GetBankData()</code> (<code>easystem_utils/source/datautils.lua</code>) and rebuilds it only when <code>GameData.Player.bankItemsDirty</code> is set. To refresh a single slot, the stock bank window uses [[API:GetSingleItem|GetSingleItem]].

== Errors ==
None.

== Example ==
From <code>default/easystem_utils/source/datautils.lua</code>:
<pre>
function DataUtils.GetBankData ()
if (GameData.Player.bankItemsDirty)
then
GameData.Player.bankItemsDirty = false
DataUtilsData.bankItems= GetBankData()
end

return DataUtilsData.bankItems
end
</pre>

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

API:GetBankData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)