C_Item

namespaceavailable in: camelot

Status in wowlua

121 functions: 31 implemented, 1 recorded, 89 guessed. 19 events, 4 of them fired by the emulator on its own.

Functions

function	what it does	status
`ActionBindsItem`	Confirms this will bind this item to you. `()`	guessed
`BindEnchant`	Confirms that enchanting an item will make it soulbound. `()`	guessed
`CanBeRefunded`	Whether the item can be refunded. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	guessed
`CanItemTransmogAppearance`	Whether the item's appearance can be used for transmogrification, and the reason when it cannot. · by wowlua `(itemLoc: ItemLocationMixin): (boolean, TransmogOutfitSlotError)`	guessed
`CanScrapItem`	Whether the item can be scrapped. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`CanViewItemPowers`	Whether the item's powers can be viewed. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`ConfirmBindOnUse`	Confirms binding an item that binds when used. · by wowlua `()`	guessed
`ConfirmDeleteItem`	Confirms deleting an item. · by wowlua `(itemGUID: string)`	guessed
`ConfirmNoRefundOnUse`	When a user purchases a refundable item from a vendor with an on-use effect (such as a toy or cosmetic) and attempts to use that item, the game will pop up a StaticPopup dialog informing the user that the item would no longer be refundable. If the user clicks the Okay button to continue using the item, this function confirms the use and dismisses the dialog. `()`	guessed
`ConfirmOnUse`	Confirms you want to use the item. `()`	guessed
`DeleteItem`	Deletes an item. · by wowlua `(itemGUID: string)`	guessed
`DoesItemContainSpec`	Whether the item is meant for the class, and for the specialization if one is given. · by wowlua `(itemInfo: ItemInfo, classID: number, specID: number): boolean`	guessed
`DoesItemExist`	Whether there is an item at the location. · by wowlua `(emptiableItemLocation: ItemLocationMixin): boolean`	implemented
`DoesItemExistByID`	Whether the item exists. · by wowlua `(itemInfo: ItemInfo): boolean`	implemented
`DoesItemMatchBonusTreeReplacement`	Whether the item matches the current bonus tree replacement. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`DoesItemMatchSpellItemCondition`	Whether the item meets the item condition of the spell being targeted. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`DoesItemMatchTargetEnchantingSpell`	Whether the item is a valid target for the enchanting spell being cast. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`DoesItemMatchTrackJump`	Whether the item matches the current upgrade track jump. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`DropItemOnUnit`	Drops an item from the cursor onto a unit, i.e. to initiate a trade. `(unitGUID: string)`	guessed
`EndBoundTradeable`	Confirms this will make this item non-tradeable. `(type: string)`	guessed
`EndRefund`	Confirms this will make this item non-refundable. `(type: number)`	guessed
`EquipItemByName`	Equips an item, optionally into a specified slot. `(itemInfo: ItemInfo, dstSlot: number?)`	guessed
`GetAppliedItemTransmogInfo`	Returns the transmog appearance applied to the item. · by wowlua `(itemLoc: ItemLocationMixin): ItemTransmogInfoMixin?`	guessed
`GetBaseItemTransmogInfo`	Returns the item's own appearance, without any transmog. · by wowlua `(itemLoc: ItemLocationMixin): ItemTransmogInfoMixin?`	guessed
`GetCurrentItemLevel`	Returns the item level of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): number?`	guessed
`GetCurrentItemTransmogInfo`	Returns the appearance the item currently shows, including any transmog. · by wowlua `(itemLoc: ItemLocationMixin): ItemTransmogInfoMixin?`	guessed
`GetDelvePreviewItemLink`	Returns the link of the item as it would drop in a delve with the given creation context. · by wowlua `(itemID: number, context: ItemCreationContext): string?`	guessed
`GetDelvePreviewItemQuality`	Returns the quality of the item as it would drop in a delve with the given creation context. · by wowlua `(itemID: number, context: ItemCreationContext): ItemQuality`	guessed
`GetDetailedItemLevelInfo`	Returns detailed item level info. `(itemInfo: ItemInfo): (number?, boolean?, number?)`	guessed
`GetFirstTriggeredSpellForItem`	Returns the ID of the first spell the item triggers at the given quality. · by wowlua `(itemID: number, itemQuality: number): number?`	guessed
`GetItemChildInfo`	Returns the IDs of the item's child items. · by wowlua `(itemInfo: ItemInfo, slotID: number?): number[]`	guessed
`GetItemClassInfo`	Returns the name of the item type. `(itemClassID: number): string`	implemented
`GetItemConversionOutputIcon`	Returns the icon of the item the given item converts into. · by wowlua `(itemLoc: ItemLocationMixin): number?`	guessed
`GetItemCooldown`	Returns cooldown info for an item ID. `(itemInfo: ItemInfo): (number, number, boolean)`	guessed
`GetItemCount`	Returns the number (or available charges) of an item in the inventory. `(itemInfo: ItemInfo, includeBank: boolean, includeUses: boolean, includeReagentBank: boolean, includeAccountBank: boolean): number`	implemented
`GetItemCreationContext`	Returns the item's ID and the context it was created in. · by wowlua `(itemInfo: ItemInfo): (number, string)`	guessed
`GetItemFamily`	Returns the bag type that an item can go into, or for bags the type of items that it can contain. `(itemInfo: ItemInfo): number?`	guessed
`GetItemGUID`	Returns the GUID of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): string`	guessed
`GetItemGem`	Returns the name and link of a gem socketed in the item. · by wowlua `(hyperlink: string, index: number): (string?, string?)`	guessed
`GetItemGemID`	Returns the item ID of a gem socketed in the item. · by wowlua `(itemInfo: ItemInfo, index: number): number?`	guessed
`GetItemID`	Returns the ID of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): number`	implemented
`GetItemIDByGUID`	Returns the ID of the item with the given GUID. · by wowlua `(itemGUID: string): number?`	guessed
`GetItemIDForItemInfo`	Returns the ID of an item given by ID, name or link, or 0 when it names no item. · by wowlua `(itemInfo: ItemInfo): number`	guessed
`GetItemIcon`	Returns the icon texture for an item. `(itemLocation: ItemLocationMixin): number?`	implemented
`GetItemIconByID`	Returns the item's icon file ID. · by wowlua `(itemInfo: ItemInfo): number?`	implemented
`GetItemInfo`	Returns info for an item. `(itemInfo: ItemInfo): (string?, string?, ItemQuality?, number?, number?, string?, string?, number?, string?, number?, number?, number?, number?, number?, number?, number?, boolean?, string?)`	implemented
`GetItemInfoInstant`	Returns readily available info for an item. `(itemInfo: ItemInfo): (number?, string?, string?, string?, number?, number?, number?)`	implemented
`GetItemInventorySlotInfo`	Returns the localized name of the equipment slot for an inventory type. · by wowlua `(inventorySlot: InventoryType): string`	implemented
`GetItemInventorySlotKey`	Returns the global string key of the equipment slot name for an inventory type. · by wowlua `(inventorySlot: InventoryType): string`	guessed
`GetItemInventoryType`	Returns the inventory type of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): InventoryType?`	guessed
`GetItemInventoryTypeByID`	Returns the item's inventory type. · by wowlua `(itemInfo: ItemInfo): InventoryType?`	guessed
`GetItemLearnTransmogSet`	Returns the ID of the transmog set the item teaches. · by wowlua `(itemInfo: ItemInfo): number?`	guessed
`GetItemLink`	Returns the link of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): string?`	implemented
`GetItemLinkByGUID`	Returns the link of the item with the given GUID. · by wowlua `(itemGUID: string): string?`	guessed
`GetItemLocation`	Returns the location of the item with the given GUID. · by wowlua `(itemGUID: string): ItemLocationMixin?`	guessed
`GetItemMaxStackSize`	Returns how many of the item at a location fit in one stack. · by wowlua `(itemLocation: ItemLocationMixin): number?`	guessed
`GetItemMaxStackSizeByID`	Returns how many of the item fit in one stack. · by wowlua `(itemInfo: ItemInfo): number?`	implemented
`GetItemName`	Returns the name of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): string?`	implemented
`GetItemNameByID`	Returns the item's name. · by wowlua `(itemInfo: ItemInfo): string?`	implemented
`GetItemNumAddedSockets`	Returns the number of sockets added to the item. · by wowlua `(itemInfo: ItemInfo): number`	guessed
`GetItemNumSockets`	Returns the number of sockets the item has. · by wowlua `(itemInfo: ItemInfo): number`	guessed
`GetItemQuality`	Returns the quality of the item at a location. · by wowlua `(itemLocation: ItemLocationMixin): ItemQuality?`	implemented
`GetItemQualityByID`	Returns the item's quality, once its data is loaded. · by wowlua `(itemInfo: ItemInfo): ItemQuality?`	implemented
`GetItemQualityColor`	Returns the color for an item quality. `(quality: ItemQuality): (number, number, number, string)`	guessed
`GetItemSetInfo`	Returns the name of an item set. · by wowlua `(setID: number): string`	guessed
`GetItemSpecInfo`	Returns the IDs of the specializations the item is meant for. · by wowlua `(itemInfo: ItemInfo): number[]?`	guessed
`GetItemSpell`	Returns the spell effect for an item. `(itemInfo: ItemInfo): (string?, number?)`	implemented
`GetItemStatDelta`	Returns the difference between the stats of two items. · by wowlua `(itemLink1: string, itemLink2: string): LuaValueVariant?`	guessed
`GetItemStats`	Returns a table of stats for an item. `(itemLink: string): LuaValueVariant?`	guessed
`GetItemSubClassInfo`	Returns the name of the item subtype. `(itemClassID: number, itemSubClassID: number): (string?, boolean?)`	implemented
`GetItemUniqueness`	Returns the item's uniqueness limits. · by wowlua `(itemInfo: ItemInfo): (number?, number?)`	guessed
`GetItemUniquenessByID`	Returns whether the item is unique, its limit category name, and its limits. · by wowlua `(itemInfo: ItemInfo): (boolean?, string?, number?, number?)`	guessed
`GetItemUpgradeInfo`	Returns the item's upgrade information. · by wowlua `(itemInfo: ItemInfo): ItemUpgradeInfo?`	guessed
`GetLimitedCurrencyItemInfo`	Returns information about a currency item with a limited quantity. · by wowlua `(itemInfo: ItemInfo): (string?, number?, number?, number?, number?)`	guessed
`GetSetBonusesForSpecializationByItemID`	Returns the IDs of the set bonuses the item gives for a specialization. · by wowlua `(specID: number, itemID: number): number[]?`	guessed
`GetStackCount`	Returns how many items are in the stack at a location. · by wowlua `(itemLocation: ItemLocationMixin): number`	implemented
`GetWeaponEnchantInfo`	Returns the temporary enchants on a weapon slot. · by wowlua `(weaponSlot: WeaponSlot): WeaponEnchantInfo[]`	recorded
`IsAnimaItemByID`	Whether the item is an anima item. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsArtifactPowerItem`	Whether the item grants artifact power. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsBound`	Whether the item at a location is bound. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	implemented
`IsBoundToAccountUntilEquip`	You can use IsItemBindToAccountUntilEquip instead if the item is not in your inventory `(itemLocation: ItemLocationMixin): boolean`	guessed
`IsConsumableItem`	Whether the item is a consumable. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsCorruptedItem`	Whether the item is corrupted. · by wowlua `(itemInfo: ItemInfo): boolean?`	implemented
`IsCosmeticItem`	Whether the item is a cosmetic item. · by wowlua `(itemInfo: ItemInfo): boolean?`	implemented
`IsCurioItem`	Returns whether the item is a consumable curio that can be applied to a delves companion. `(itemInfo: ItemInfo): boolean?`	implemented
`IsCurrentItem`	Whether the player is currently using the item, such as casting its use spell. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsDecorItem`	Returns whether the item is a consumable decor item. `(itemInfo: ItemInfo): boolean?`	implemented
`IsDressableItemByID`	Returns true if the item is an Armor or Weapon type and false for all other items (Necklace, Trinkets, Rings, Consumables, etc.). `(itemInfo: ItemInfo): boolean`	guessed
`IsEquippableItem`	Returns true if an item is equipable by the player. `(itemInfo: ItemInfo): boolean`	implemented
`IsEquippedItem`	Whether the player has the item equipped. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsEquippedItemType`	Returns true if an item of a given type is equipped. `(type: string): boolean`	guessed
`IsHarmfulItem`	Returns whether an item can be used against hostile units. `(itemInfo: ItemInfo): boolean`	guessed
`IsHelpfulItem`	Returns whether an item can be used on the player or friendly units. `(itemInfo: ItemInfo): boolean`	guessed
`IsItemBindToAccount`	Whether the item binds to the account. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsItemBindToAccountUntilEquip`	You can use IsBoundToAccountUntilEquip instead if the item exists in your inventory `(itemInfo: ItemInfo): boolean`	guessed
`IsItemConduit`	Whether the item is a conduit. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`IsItemConvertibleAndValidForPlayer`	Whether the item can be converted and the result is valid for the player. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`IsItemCorrupted`	Whether the item is corrupted. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`IsItemCorruptionRelated`	Whether the item is related to corruption. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`IsItemCorruptionResistant`	Whether the item resists corruption. · by wowlua `(itemLoc: ItemLocationMixin): boolean`	guessed
`IsItemDataCached`	Whether the data of the item at a location is loaded. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	guessed
`IsItemDataCachedByID`	Whether the item's data is loaded. · by wowlua `(itemInfo: ItemInfo): boolean`	implemented
`IsItemGUIDInInventory`	Whether the item with the given GUID is in the player's bags or equipped. · by wowlua `(itemGUID: string): boolean`	guessed
`IsItemInRange`	Returns whether the item is in usable range of the unit. `(itemInfo: ItemInfo, targetToken: string): boolean?`	guessed
`IsItemKeystoneByID`	Whether the item is a Mythic+ keystone. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsItemSpecificToPlayerClass`	Whether the item is restricted to the player's class. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`IsLocked`	Whether the item at a location is locked, such as while it is being moved or traded. · by wowlua `(itemLocation: ItemLocationMixin): boolean`	implemented
`IsRelicItem`	Returns whether the item is a consumable relic that can be applied to an artifact weapon. `(itemInfo: ItemInfo): boolean?`	implemented
`IsUsableItem`	Returns whether the player can use the item, and whether using it fails only for lack of mana. · by wowlua `(itemInfo: ItemInfo): (boolean, boolean)`	guessed
`ItemHasRange`	Whether the item's use has a range. · by wowlua `(itemInfo: ItemInfo): boolean`	guessed
`LockItem`	Locks the item at a location. · by wowlua `(itemLocation: ItemLocationMixin)`	implemented
`LockItemByGUID`	Locks the item with the given GUID. · by wowlua `(itemGUID: string)`	guessed
`PickupItem`	Puts the item on the cursor. · by wowlua `(itemInfo: ItemInfo)`	guessed
`ReplaceEnchant`	Confirms the "Replace Enchant" dialog. `()`	guessed
`ReplaceTradeEnchant`	Confirms that an enchant applied to the trade frame should replace an existing enchant. `()`	guessed
`ReplaceTradeskillEnchant`	Confirms replacing the item's existing enchant with the one being applied. · by wowlua `()`	guessed
`RequestLoadItemData`	Requests item data and fires `ITEM_DATA_LOAD_RESULT`. `(itemLocation: ItemLocationMixin)`	guessed
`RequestLoadItemDataByID`	Asks the server for the item's data, so it can be read once loaded. · by wowlua `(itemInfo: ItemInfo)`	implemented
`UnlockItem`	Unlocks the item at a location. · by wowlua `(itemLocation: ItemLocationMixin)`	implemented
`UnlockItemByGUID`	Unlocks the item with the given GUID. · by wowlua `(itemGUID: string)`	guessed
`UseItemByName`	Uses the specified item. `(itemInfo: ItemInfo, target: string?)`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`ACTION_WILL_BIND_ITEM`	`no payload`	not implemented
`BIND_ENCHANT`	`no payload`	not implemented
`CHARACTER_ITEM_FIXUP_NOTIFICATION`	`fixupVersion: number`	not implemented
`CONFIRM_BEFORE_USE`	`no payload`	not implemented
`CONVERT_TO_BIND_TO_ACCOUNT_CONFIRM`	`no payload`	not implemented
`DELETE_ITEM_CONFIRM`	`itemName: string, qualityID: number, bonding: number, questWarn: number, itemGUID: string?`	implemented
`END_BOUND_TRADEABLE`	`reason: string`	not implemented
`GET_ITEM_INFO_RECEIVED`	`itemID: number, success: boolean`	implemented
`ITEM_CHANGED`	`previousHyperlink: string, newHyperlink: string`	not implemented
`ITEM_CONVERSION_DATA_READY`	`itemGUID: string`	not implemented
`ITEM_COUNT_CHANGED`	`itemID: number`	implemented
`ITEM_DATA_LOAD_RESULT`	`itemID: number, success: boolean`	implemented
`MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL`	`itemLink: string`	not implemented
`REPLACE_ENCHANT`	`existingStr: string, replacementStr: string`	not implemented
`REPLACE_TRADESKILL_ENCHANT`	`existing: string, replacement: string`	not implemented
`TRADE_REPLACE_ENCHANT`	`existing: string, replacement: string`	not implemented
`USE_BIND_CONFIRM`	`no payload`	not implemented
`USE_NO_REFUND_CONFIRM`	`no payload`	not implemented
`WEAPON_ENCHANT_CHANGED`	`no payload`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ACTION_WILL_BIND_ITEM").

Structures

ItemInfoResult · itemName, itemLink, itemQuality, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount, itemEquipLoc, itemTexture, sellPrice, classID, subclassID, bindType, expansionID, setID?, isCraftingReagent, itemDescription
ItemUpgradeInfo · currentLevel, maxLevel, maxItemLevel, trackString?, trackStringID?
WeaponEnchantInfo · hasEnchant, enchantType, timeLeft, charges, enchantID, enchantIconID

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (Item system, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.