ItemLocationMixin

Main Menu
WoW API Lua API FrameXML Widget API Widget scripts XML schema Events CVars Macro commands Combat Log Escape sequences Hyperlinks API changes HOWTOs wowuidev

→ All Mixins

ItemLocationMixin objects can only be created for items in your equipment or inventory.

Source: FrameXML\ObjectAPI\ItemLocation.lua

API

• ItemLocation:CreateEmpty() : itemLocation - Creates an empty object.
• ItemLocation:CreateFromBagAndSlot(bagID, slotIndex) : itemLocation - Creates an object from a bagID and slotIndex.
• ItemLocation:CreateFromEquipmentSlot(equipmentSlotIndex) : itemLocation - Creates an object from an inventorySlotId.

Methods

• ItemLocationMixin:Clear()
• ItemLocationMixin:SetBagAndSlot(bagID, slotIndex)
• ItemLocationMixin:GetBagAndSlot() : bagID, slotIndex
• ItemLocationMixin:SetEquipmentSlot(equipmentSlotIndex)
• ItemLocationMixin:GetEquipmentSlot() : equipmentSlotIndex
• ItemLocationMixin:IsEquipmentSlot() : boolean
• ItemLocationMixin:IsBagAndSlot() : boolean
• ItemLocationMixin:HasAnyLocation() : boolean
• ItemLocationMixin:IsValid() : boolean
• ItemLocationMixin:IsEqualToBagAndSlot(bagID, slotIndex) : boolean
• ItemLocationMixin:IsEqualToEquipmentSlot(equipmentSlotIndex) : boolean
• ItemLocationMixin:IsEqualTo(itemLocation) : boolean

Example

Prints the ID and name of the item in your head slot.

local itemLoc = ItemLocation:CreateFromEquipmentSlot(INVSLOT_HEAD)

if itemLoc:IsValid() then
	local id = C_Item.GetItemID(itemLoc)
	local name = C_Item.GetItemName(itemLoc)
	print(id, name) -- 21524, "Red Winter Hat"
end

The minimal representation is a table with the equipmentSlotIndex or bagID, slotIndex fields.

/dump C_Item.GetItemName({equipmentSlotIndex = 1})

Used by

Note: This list is up to date as of Patch 10.0.2 (46879) Nov 29 2022

Function arguments C_ArtifactUI.IsArtifactItem C_AuctionHouse.CalculateItemDeposit C_AuctionHouse.ConfirmPostCommodity C_AuctionHouse.ConfirmPostItem C_AuctionHouse.GetAvailablePostCount C_AuctionHouse.GetItemCommodityStatus C_AuctionHouse.GetItemKeyFromItem C_AuctionHouse.IsSellItemValid C_AuctionHouse.PostCommodity C_AuctionHouse.PostItem C_AzeriteEmpoweredItem.CanSelectPower C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec C_AzeriteEmpoweredItem.GetAllTierInfo C_AzeriteEmpoweredItem.GetPowerText C_AzeriteEmpoweredItem.HasAnyUnselectedPowers C_AzeriteEmpoweredItem.HasBeenViewed C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem C_AzeriteEmpoweredItem.IsPowerSelected C_AzeriteEmpoweredItem.SelectPower C_AzeriteEmpoweredItem.SetHasBeenViewed C_AzeriteItem.GetAzeriteItemXPInfo C_AzeriteItem.GetPowerLevel C_AzeriteItem.GetUnlimitedPowerLevel C_AzeriteItem.IsAzeriteItem C_AzeriteItem.IsAzeriteItemEnabled C_ChallengeMode.CanUseKeystoneInCurrentMap C_Item.CanItemTransmogAppearance C_Item.CanScrapItem C_Item.CanViewItemPowers C_Item.DoesItemExist C_Item.DoesItemMatchBonusTreeReplacement C_Item.GetAppliedItemTransmogInfo C_Item.GetBaseItemTransmogInfo C_Item.GetCurrentItemLevel C_Item.GetCurrentItemTransmogInfo C_Item.GetItemConversionOutputIcon C_Item.GetItemGUID C_Item.GetItemID C_Item.GetItemIcon C_Item.GetItemInventoryType C_Item.GetItemLink C_Item.GetItemMaxStackSize C_Item.GetItemName C_Item.GetItemQuality C_Item.GetStackCount C_Item.IsBound C_Item.IsItemConduit C_Item.IsItemConvertibleAndValidForPlayer C_Item.IsItemCorrupted C_Item.IsItemCorruptionRelated C_Item.IsItemCorruptionResistant C_Item.IsItemDataCached C_Item.IsLocked C_Item.LockItem C_Item.RequestLoadItemData C_Item.UnlockItem C_ItemInteraction.GetItemConversionCurrencyCost C_ItemInteraction.SetPendingItem C_ItemUpgrade.CanUpgradeItem C_ItemUpgrade.SetItemUpgradeFromLocation C_LegendaryCrafting.GetRuneforgeItemPreviewInfo C_LegendaryCrafting.GetRuneforgeLegendaryComponentInfo C_LegendaryCrafting.GetRuneforgeLegendaryCost C_LegendaryCrafting.GetRuneforgeLegendaryUpgradeCost C_LegendaryCrafting.GetRuneforgeModifierInfo C_LegendaryCrafting.GetRuneforgePowers C_LegendaryCrafting.IsRuneforgeLegendary C_LegendaryCrafting.IsRuneforgeLegendaryMaxLevel C_LegendaryCrafting.IsUpgradeItemValidForRuneforgeLegendary C_LegendaryCrafting.IsValidRuneforgeBaseItem C_LegendaryCrafting.MakeRuneforgeCraftDescription C_LegendaryCrafting.UpgradeRuneforgeLegendary C_MountJournal.ApplyMountEquipment C_MountJournal.IsItemMountEquipment C_QuestItemUse.CanUseQuestItemOnObject C_Sound.PlayItemSound C_TradeSkillUI.CraftEnchant C_TradeSkillUI.CraftSalvage C_TradeSkillUI.DoesRecraftingRecipeAcceptItem

Function returns C_AzeriteItem.FindActiveAzeriteItem C_Cursor.GetCursorItem C_Item.GetItemLocation C_ScrappingMachineUI.GetCurrentPendingScrapItemLocationByIndex

Events AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED AZERITE_ITEM_EXPERIENCE_CHANGED AZERITE_ITEM_POWER_LEVEL_CHANGED ITEM_INTERACTION_ITEM_SELECTION_UPDATED

Structures RuneforgeLegendaryCraftDescription C_LegendaryCrafting.CraftRuneforgeLegendary C_LegendaryCrafting.MakeRuneforgeCraftDescription UnlockedAzeriteEmpoweredItems AZERITE_ITEM_POWER_LEVEL_CHANGED

Patch changes

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

External links

  Search FrameXML