WoW:API GetInventoryItemCount: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetInventoryItemCount to API GetInventoryItemCount without leaving a redirect)
 
(7 intermediate revisions by 7 users not shown)
Line 1: Line 1:
<center>'''GetInventoryItemCount''' ''-Documentation by [[user:ulic|ulic]]-''</center>
{{wowapi}}
Determine the quantity of an item in an inventory slot.


<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args -->
count = GetInventoryItemCount("unit", slotId)
== Parameters ==
=== Arguments ===
:("unit", slotId)


GetInventoryItemCount("unit", slot);
:;unit : String - The [[API TYPE UnitId|UnitId]] of the unit whose inventory is to be queried.
:;slotId : Numeric - The [[API TYPE InventorySlotID|inventory slot]] to be queried, obtained via [[API GetInventorySlotInfo|GetInventorySlotInfo]].


<!-- Describe the purpose of the function, though exhausting detail can be saved for a later section -->
=== Returns ===
:count


Gets the quantity for an item in an Inventory Slot.  Only known use for this is the ranged slot, for throwing weapons.
:;count : Numeric - Returns 1 on empty slots (Thus, on empty ammo slot, 1 is returned). For containers (Bags, etc.), this returns the number of items stored inside the container (Thus, empty containers return 0). Under all other conditions, this function returns the amount of items in the specified slot.
 
== Example ==
----
<!-- begin code -->
;''Arguments''
local ammoSlot = GetInventorySlotInfo("AmmoSlot");
 
  local ammoCount = GetInventoryItemCount("player", ammoSlot);
<!-- List each argument, together with its type -->
if ((ammoCount == 1) and (not GetInventoryItemTexture("player", ammoSlot))) then
:(unit, slot)
    ammoCount = 0;
:;unit : String - the string identifing where to get the slot info from
end;
:;slot : Integer - the integer number of the inventory slot
<!-- end code -->
 
----
;''Returns''
 
<!-- List each return value, together with its type -->
:Integer - the number of the item in the specified slot
 
----
;''Example''
  itemCount = GetInventoryItemCount("player", index);
----
----
{{Template:WoW API}} :
__NOTOC__
<!-- Update the category to the appropriate subsection, and be sure to put the function name as the label for the category link. Multiple subcategories are okay if appropriate, please dont link functions to the API Functions category directly. -->
[[World of Warcraft API#Inventory_Functions|Inventory Functions]]
[[Category:API Inventory Functions|PickupContainerItem]]

Latest revision as of 04:46, 15 August 2023

← WoW API < GetInventoryItemCount

Determine the quantity of an item in an inventory slot. 

count = GetInventoryItemCount("unit", slotId)

Parameters[edit]

Arguments[edit]

("unit", slotId)
unit
String - The UnitId of the unit whose inventory is to be queried.
slotId
Numeric - The inventory slot to be queried, obtained via GetInventorySlotInfo.

Returns[edit]

count
count
Numeric - Returns 1 on empty slots (Thus, on empty ammo slot, 1 is returned). For containers (Bags, etc.), this returns the number of items stored inside the container (Thus, empty containers return 0). Under all other conditions, this function returns the amount of items in the specified slot.

Example[edit]

local ammoSlot = GetInventorySlotInfo("AmmoSlot");
local ammoCount = GetInventoryItemCount("player", ammoSlot);
if ((ammoCount == 1) and (not GetInventoryItemTexture("player", ammoSlot))) then
    ammoCount = 0;
end;
Retrieved from "https://addonstudio.org/mw/index.php?title=WoW:API_GetInventoryItemCount&oldid=19078"