Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:40Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Returns the first item waiting in the player's inventory overflow, and how many overflow items there are.

<pre>
item, count = GetOverflowData()
</pre>

== Arguments ==
None.

== Returns ==
;item : <code>table</code> – [[API:GetInventoryItemData#Item data table|Item data table]] of the first item in the overflow. A table is returned even when the overflow is empty, so check <code>count</code> first.
;count : <code>number</code> – Number of items in the overflow.

== Details ==
* Only one item is returned, however many are waiting. The stock UI comments call it "the topmost overflow itemData".
* If there is no player object or the Lua state is not available, nothing is returned.
* The stock backpack window calls it once at start-up and otherwise relies on <code>SystemData.Events.PLAYER_INVENTORY_OVERFLOW_UPDATED</code>.

== Errors ==
None.

== Example ==
From <code>default/ea_backpackwindow/source/backpackwindow.lua</code>:
<pre>
function EA_Window_Backpack.InitializeOverflowSlot()

WindowRegisterEventHandler( EA_Window_Backpack.windowName, SystemData.Events.PLAYER_INVENTORY_OVERFLOW_UPDATED, "EA_Window_Backpack.OnOverflowSlotUpdated")

local overflowItem, overflowCount = GetOverflowData()
EA_Window_Backpack.OnOverflowSlotUpdated( overflowItem, overflowCount )
end
</pre>

From <code>default/easystem_utils/source/datautils.lua</code>:
<pre>
return GetOverflowData() -- only returns the topmost overflow itemData
</pre>

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

API:GetOverflowData - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)