Changes: Enum.InventoryType

Revision as of 16:49, 2 December 2021

Items can have an InventoryType / ItemEquipLoc that indicate in what InventorySlotId they can be equipped.

InventoryType (number) is returned from C_Item.GetItemInventoryType()
ItemEquipLoc (string) is returned from GetItemInfo() and also doubles as a GlobalString

Example

Prints the inventory type for [Red Winter Hat], and the related ItemEquipLoc and globalstring.

local invType = C_Item.GetItemInventoryTypeByID(21524)
print(invType) -- 1

local equipLoc = select(9, GetItemInfo(21524))
print(equipLoc, _G[equipLoc]) -- "INVTYPE_HEAD", "Head"

Values

Note: The range is documented in Blizzard API Documentation as [0-28] but C_Transmog.GetSlotForInventoryType() and EJ_GetInvTypeSortOrder() are off-by-one and use [1-29] instead.

**Enum.InventoryType**
Value	Key	ItemEquipLoc GlobalString (enUS)		InvSlotId
0	IndexNonEquipType	INVTYPE_NON_EQUIP	Non-equippable
1	IndexHeadType	INVTYPE_HEAD	Head	1
2	IndexNeckType	INVTYPE_NECK	Neck	2
3	IndexShoulderType	INVTYPE_SHOULDER	Shoulder	3
4	IndexBodyType	INVTYPE_BODY	Shirt	4
5	IndexChestType	INVTYPE_CHEST	Chest	5
6	IndexWaistType	INVTYPE_WAIST	Waist	6
7	IndexLegsType	INVTYPE_LEGS	Legs	7
8	IndexFeetType	INVTYPE_FEET	Feet	8
9	IndexWristType	INVTYPE_WRIST	Wrist	9
10	IndexHandType	INVTYPE_HAND	Hands	10
11	IndexFingerType	INVTYPE_FINGER	Finger	11, 12
12	IndexTrinketType	INVTYPE_TRINKET	Trinket	13, 14
13	IndexWeaponType	INVTYPE_WEAPON	One-Hand	16, 17: Dual wield
14	IndexShieldType	INVTYPE_SHIELD	Off Hand	17
15	IndexRangedType	INVTYPE_RANGED	Ranged	16
16	IndexCloakType	INVTYPE_CLOAK	Back	15
17	Index2HweaponType	INVTYPE_2HWEAPON	Two-Hand	16
18	IndexBagType	INVTYPE_BAG	Bag
19	IndexTabardType	INVTYPE_TABARD	Tabard	19
20	IndexRobeType	INVTYPE_ROBE	Chest	5
21	IndexWeaponmainhandType	INVTYPE_WEAPONMAINHAND	Main Hand	16
22	IndexWeaponoffhandType	INVTYPE_WEAPONOFFHAND	Off Hand	16
23	IndexHoldableType	INVTYPE_HOLDABLE	Held In Off-hand	17
24	IndexAmmoType	INVTYPE_AMMO	Ammo
25	IndexThrownType	INVTYPE_THROWN	Thrown	16
26	IndexRangedrightType	INVTYPE_RANGEDRIGHT	Ranged	16
27	IndexQuiverType	INVTYPE_QUIVER	Quiver
28	IndexRelicType	INVTYPE_RELIC	Relic

Patch changes

Patch 8.0.1 (2018-07-17): Added Enum.InventoryType

@@ Line 1: / Line 1: @@
 {{wowapitype}}
+Items can have an InventoryType / ItemEquipLoc that indicate in what [[InventorySlotId]] they can be equipped.
-Enumeration in the Item system.
+* InventoryType <small>(number)</small> is returned from {{api|C_Item.GetItemInventoryType}}()
-* The value range is [https://www.townlong-yak.com/framexml/8.2.0/Blizzard_APIDocumentation/ItemDocumentation.lua#438 documented] in Blizzard API Documentation as [0-28] but {{api|C_Transmog.GetSlotForInventoryType}} and {{api|EJ_GetInvTypeSortOrder}} use [1-29] instead.
+* ItemEquipLoc <small>(string)</small> is returned from {{api|GetItemInfo}}() and also doubles as a [https://www.townlong-yak.com/framexml/9.0.2/GlobalStrings.lua#8852 GlobalString]
+== Example ==
-<onlyinclude>{| class="sortable darktable zebra"
+Prints the inventory type for [[Red Winter Hat]], and the related ItemEquipLoc and globalstring.
-|+ [[Enum_Item.InventoryType|Enum.InventoryType]]
+<syntaxhighlight lang="lua">
-|-
+local invType = C_Item.GetItemInventoryTypeByID(21524)
-! Value !! Type !! colspan="2" | GlobalString !! Description
+print(invType) -- 1
+local equipLoc = select(9, GetItemInfo(21524))
+print(equipLoc, _G[equipLoc]) -- "INVTYPE_HEAD", "Head"
+</syntaxhighlight>
+== Values ==
+{{i-note|The range is [https://www.townlong-yak.com/framexml/8.2.0/Blizzard_APIDocumentation/ItemDocumentation.lua#438 documented] in Blizzard API Documentation as [0-28] but {{api|C_Transmog.GetSlotForInventoryType}}() and {{api|EJ_GetInvTypeSortOrder}}() are off-by-one and use [1-29] instead.}}
+<onlyinclude>{| class="sortable darktable zebra col1-center" style="margin-left: 2em"
+|+ {{#if:{{{nocaption|}}}||[[Enum.InventoryType]]}}
+! Value !! Key !! colspan="2" | ItemEquipLoc<br>GlobalString (enUS) !! colspan="2" | [[InvSlotId]]
 |-
-| <center>0</center> || IndexNonEquipType || INVTYPE_NON_EQUIP || Non-equippable ||
+| 0 || IndexNonEquipType || INVTYPE_NON_EQUIP || Non-equippable ||
 |-
-| <center>1</center> || IndexHeadType || INVTYPE_HEAD || Head ||
+| 1 || IndexHeadType || INVTYPE_HEAD || Head || 1
 |-
-| <center>2</center> || IndexNeckType || INVTYPE_NECK || Neck ||
+| 2 || IndexNeckType || INVTYPE_NECK || Neck || 2
 |-
-| <center>3</center> || IndexShoulderType || INVTYPE_SHOULDER || Shoulder ||
+| 3 || IndexShoulderType || INVTYPE_SHOULDER || Shoulder || 3
 |-
-| <center>4</center> || IndexBodyType || INVTYPE_BODY || Shirt ||
+| 4 || IndexBodyType || INVTYPE_BODY || Shirt || 4
 |-
-| <center>5</center> || IndexChestType || INVTYPE_CHEST || Chest ||
+| 5 || IndexChestType || INVTYPE_CHEST || Chest || 5
 |-
-| <center>6</center> || IndexWaistType || INVTYPE_WAIST || Waist ||
+| 6 || IndexWaistType || INVTYPE_WAIST || Waist || 6
 |-
-| <center>7</center> || IndexLegsType || INVTYPE_LEGS || Legs ||
+| 7 || IndexLegsType || INVTYPE_LEGS || Legs || 7
 |-
-| <center>8</center> || IndexFeetType || INVTYPE_FEET || Feet ||
+| 8 || IndexFeetType || INVTYPE_FEET || Feet || 8
 |-
-| <center>9</center> || IndexWristType || INVTYPE_WRIST || Wrist ||
+| 9 || IndexWristType || INVTYPE_WRIST || Wrist || 9
 |-
-| <center>10</center> || IndexHandType || INVTYPE_HAND || Hands ||
+| 10 || IndexHandType || INVTYPE_HAND || Hands || 10
 |-
-| <center>11</center> || IndexFingerType || INVTYPE_FINGER || Finger ||
+| 11 || IndexFingerType || INVTYPE_FINGER || Finger || 11, 12
 |-
-| <center>12</center> || IndexTrinketType || INVTYPE_TRINKET || Trinket ||
+| 12 || IndexTrinketType || INVTYPE_TRINKET || Trinket || 13, 14
 |-
-| <center>13</center> || IndexWeaponType || INVTYPE_WEAPON || One-Hand ||
+| 13 || IndexWeaponType || INVTYPE_WEAPON || One-Hand || 16, 17: [[Dual wield]]
 |-
-| <center>14</center> || IndexShieldType || INVTYPE_SHIELD || Off Hand ||
+| 14 || IndexShieldType || INVTYPE_SHIELD || Off Hand || 17
 |-
-| <center>15</center> || IndexRangedType || INVTYPE_RANGED || Ranged || Bows
+| 15 || IndexRangedType || INVTYPE_RANGED || Ranged || 16
 |-
-| <center>16</center> || IndexCloakType || INVTYPE_CLOAK || Back ||
+| 16 || IndexCloakType || INVTYPE_CLOAK || Back || 15
 |-
-| <center>17</center> || Index2HweaponType || INVTYPE_2HWEAPON || Two-Hand ||
+| 17 || Index2HweaponType || INVTYPE_2HWEAPON || Two-Hand || 16
 |-
-| <center>18</center> || IndexBagType || INVTYPE_BAG || Bag || Containers
+| 18 || IndexBagType || INVTYPE_BAG || Bag ||
 |-
-| <center>19</center> || IndexTabardType || INVTYPE_TABARD || Tabard ||
+| 19 || IndexTabardType || INVTYPE_TABARD || Tabard || 19
 |-
-| <center>20</center> || IndexRobeType || INVTYPE_ROBE || Chest ||
+| 20 || IndexRobeType || INVTYPE_ROBE || Chest || 5
 |-
-| <center>21</center> || IndexWeaponmainhandType || INVTYPE_WEAPONMAINHAND || Main Hand ||
+| 21 || IndexWeaponmainhandType || INVTYPE_WEAPONMAINHAND || Main Hand || 16
 |-
-| <center>22</center> || IndexWeaponoffhandType || INVTYPE_WEAPONOFFHAND || Off Hand ||
+| 22 || IndexWeaponoffhandType || INVTYPE_WEAPONOFFHAND || Off Hand || 16
 |-
-| <center>23</center> || IndexHoldableType || INVTYPE_HOLDABLE || Held In Off-hand ||
+| 23 || IndexHoldableType || INVTYPE_HOLDABLE || Held In Off-hand || 17
 |-
-| <center>24</center> || IndexAmmoType || INVTYPE_AMMO || Ammo ||
+| 24 || IndexAmmoType || INVTYPE_AMMO || Ammo ||
 |-
-| <center>25</center> || IndexThrownType || INVTYPE_THROWN || Thrown ||
+| 25 || IndexThrownType || INVTYPE_THROWN || Thrown || 16
 |-
-| <center>26</center> || IndexRangedrightType || INVTYPE_RANGEDRIGHT || Ranged || Wands, Guns, and Crossbows
+| 26 || IndexRangedrightType || INVTYPE_RANGEDRIGHT || Ranged || 16
 |-
-| <center>27</center> || IndexQuiverType || INVTYPE_QUIVER || Quiver ||
+| 27 || IndexQuiverType || INVTYPE_QUIVER || Quiver ||
 |-
-| <center>28</center> || IndexRelicType || INVTYPE_RELIC || Relic ||
+| 28 || IndexRelicType || INVTYPE_RELIC || Relic ||
 |}</onlyinclude>
-==See also==
+== Patch changes ==
+* {{Patch 8.0.1|note=Added <code>Enum.InventoryType</code>}}
-* [[ItemEquipLoc]]