WoW API: GetItemCount

Reference e
AddOns WoW API Widget API XML UI Event API WoW Lua Macro API CVars Battle.net HOWTOs Snippets UI tech Categories

→ WoW API

← WoW API < GetItemCount

Returns count information for the item.

count = GetItemCount(itemID or "itemName" or "itemLink"[, includeBank][, includeCharges])

Arguments

(itemId or "itemName" or "itemLink", includeBank, includeCharges)

itemId

Integer - The numeric ID of the item. ie. 12345

itemName

String - The Name of the Item, ex: "Hearthstone"

itemLink

String - The itemLink, when Shift-Clicking items.

includeBank

Boolean - true: count includes bank items

includeCharges

Boolean - true: count is charges if any, otherwise number of items

Returns

count

Number - The number of items in your possesion, or charges if includeCharges is true and the item has charges.

Example

local count = GetItemCount(29434)
print("Badge of Justice:", count)

local count = GetItemCount(33312, nil, true) 
print("Mana Saphire Charges:", count)

local countBags = GetItemCount("Netherweave Cloth")
local countTotal = GetItemCount("Netherweave Cloth", true)
print("Netherweave Cloth:", countBags, "(bags)", (countTotal - countBags), "(bank)")

---