Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:44:16Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=Item}}
Returns how many of an item the player has, by item id.

<pre>
count = GetItemStackCount(itemId)
</pre>

== Arguments ==
;itemId : <code>number</code> – Item id (the <code>id</code> field of an [[API:GetInventoryItemData#Item data table|item data table]]).

== Returns ==
;count : <code>number</code> – The count the client keeps for that item id, added up over all stacks. 0 if the player has none.

== Details ==
* The value comes from a running total the client keeps per item id. It does not walk the backpacks.
* If there is no player object, or the argument check fails, the function still returns 0.
* Exactly one argument must be passed.

== Errors ==
None besides the generic ''Invalid Parameters'' message when the argument is missing or not a number.

== Example ==
Showing the total count on an action button that uses an item, from <code>default/ea_actionbars/source/actionbutton.lua</code>:
<pre>
if (actionType == GameData.PlayerActions.USE_ITEM)
then
local totalCount = GetItemStackCount (actionId)

if (totalCount > 1)
then
showCountWindow = true
self.m_Windows[STACK_COUNT_TEXT]:SetText (totalCount)
end
</pre>

From <code>default/ea_interactionwindow/source/interactionaltar.lua</code>:
<pre>
EA_Window_InteractionAltar.numItemsInBackpack = GetItemStackCount( altarData.donationType )
</pre>

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

API:GetItemStackCount - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)