276 KiB
ClassicAPI — Lua Reference
Per-function reference for the calls ClassicAPI adds to the WoW 1.12.1 Lua environment. See the project README for installation and build instructions.
Contents
-
C_Container.GetContainerItemID(bagIndex, slotIndex)GetItemCooldown(itemInfo)/C_Container.GetItemCooldown(itemID)C_Container.GetContainerItemDurability(containerIndex, slotIndex)C_Container.GetContainerItemRepairCost(containerIndex, slotIndex)C_Container.GetContainerNumFreeSlots(bagID)C_Container.PlayerHasHearthstone()C_Container.UseHearthstone()C_Container.SwapItems(srcBag, srcSlot, dstBag, dstSlot)C_Container.MoveItem(srcBag, srcSlot, dstBag, dstSlot, count)C_Item.UseItemByName(itemInfo)
-
- Overview & file format
C_EquipmentSet.CanUseEquipmentSets()C_EquipmentSet.GetNumEquipmentSets()C_EquipmentSet.GetEquipmentSetIDs()C_EquipmentSet.GetEquipmentSetID(name)C_EquipmentSet.GetEquipmentSetInfo(setID)C_EquipmentSet.GetIgnoredSlots(setID)C_EquipmentSet.GetItemIDs(setID)C_EquipmentSet.GetItemLocations(setID)C_EquipmentSet.CreateEquipmentSet(name [, icon])C_EquipmentSet.SaveEquipmentSet(setID [, icon])C_EquipmentSet.ModifyEquipmentSet(setID, newName)C_EquipmentSet.DeleteEquipmentSet(setID)C_EquipmentSet.IgnoreSlotForSave(slot)/UnignoreSlotForSave/IsSlotIgnoredForSave/ClearIgnoredSlotsForSaveC_EquipmentSet.EquipmentSetContainsLockedItems(setID)C_EquipmentSet.UseEquipmentSet(setID)
-
C_EventUtils.IsEventValid(eventName)BAG_UPDATE_DELAYEDeventHEARTHSTONE_BOUNDevent- Player input-state events (
PLAYER_STARTED_MOVING/LOOKING/TURNING+STOPPED_*) GLOBAL_MOUSE_DOWN/GLOBAL_MOUSE_UPeventsEQUIPMENT_SETS_CHANGEDeventEQUIPMENT_SWAP_PENDINGeventEQUIPMENT_SWAP_FINISHEDeventFACTION_STANDING_CHANGEDeventMODIFIER_STATE_CHANGEDeventQUEST_ACCEPTEDeventQUEST_TURNED_INeventUPDATE_SHAPESHIFT_FORMevent
-
GetFactionIDByIndex(factionIndex)GetFactionInfoByID(factionID)GetFactionParentID(factionID)C_Reputation.GetFactionStandings()C_Reputation.GetWatchedFactionData()C_Reputation.GetFactionDataByIndex(factionSortIndex)C_Reputation.SetWatchedFactionByID(factionID)C_Reputation.GetLastStandingChange()
-
GameTooltip:SetSpellByID(spellID)GameTooltip:SetTalentByID(talentID)GameTooltip:SetInventoryItemByID(itemID)GameTooltip:SetEquipmentSet(name)GameTooltip:GetItem()GameTooltip:GetSpell()GameTooltip:HasItem()/GameTooltip:HasSpell()GameTooltip:GetUnitGUID()/GameTooltip:HasUnit()GameTooltip:GetGameObject()/GameTooltip:HasGameObject()GameTooltip:GetOwner()
-
C_GossipInfo.GetText()C_GossipInfo.GetOptions()C_GossipInfo.GetAvailableQuests()C_GossipInfo.GetActiveQuests()C_GossipInfo.GetNumOptions()/GetNumAvailableQuests()/GetNumActiveQuests()C_GossipInfo.SelectOption(gossipOptionID)/SelectOptionByIndex(orderIndex)C_GossipInfo.SelectAvailableQuest(questID)C_GossipInfo.SelectActiveQuest(questID)C_GossipInfo.CloseGossip()
-
C_Item.IsBound(itemLocation)C_Item.GetItemID(itemLocation)GetInventoryItemID(unit, slot)GetInventoryItemDurability(invSlot)GetInventoryItemsForSlot(slot, returnTable [, transmogrify])GetInventoryItemRepairCost(invSlot)C_Item.GetItemFamily(item)C_Item.GetItemCount(itemInfo, [includeBank], [includeUses])GetItemIcon(itemID)/C_Item.GetItemIcon(itemLocation)/C_Item.GetItemIconByID(item)C_Item.GetItemInfoInstant(item)C_Item.IsItemDataCachedByID(item)/C_Item.IsItemDataCached(itemLocation)C_Item.RequestLoadItemDataByID(item)/C_Item.RequestLoadItemData(itemLocation)C_Item.GetItemSpell(item)OffhandHasWeapon()C_Item.IsEquippableItem(item)C_Item.IsEquippedItem(item)C_Item.EquipItemByName(itemInfo [, dstSlot])C_Item.DoesItemExist(itemLocation)/C_Item.DoesItemExistByID(item)C_Item.GetItemName(itemLocation)/C_Item.GetItemNameByID(item)C_Item.GetItemQuality(itemLocation)/C_Item.GetItemQualityByID(item)C_Item.GetItemSetID(itemLocation)/C_Item.GetItemSetIDByID(item)C_Item.GetItemSetInfo(setID)C_Item.GetItemSellPrice(itemLocation)/C_Item.GetItemSellPriceByID(item)C_Item.GetCurrentItemLevel(itemLocation)/C_Item.GetDetailedItemLevelInfo(item)GetAverageItemLevel()C_Item.GetItemMaxStackSize(itemLocation)/C_Item.GetItemMaxStackSizeByID(item)C_Item.GetItemLink(itemLocation)C_Item.GetItemInventoryType(itemLocation)/C_Item.GetItemInventoryTypeByID(item)C_Item.IsLocked(itemLocation)C_Item.LockItem(itemLocation)C_Item.LockItemByGUID(itemGUID)C_Item.UnlockItem(itemLocation)C_Item.UnlockAllItems()C_Item.GetItemGUID(itemLocation)C_Item.GetItemLocation(itemGUID)Get*ItemID— companions to the engine'sGet*ItemLinkfamily
-
GetPlayerInfoByGUID(guid)C_PlayerCache.GetPlayerInfoByName(name)C_PlayerInfo.GUIDIsPlayer(guid)/GUIDIsCreature/GUIDIsPet/GUIDIsGameObjectC_CreatureInfo.GetCreatureID(guid)C_PlayerCache.RememberPlayer(guid, name, classToken)C_PlayerCache.SetEnabled(enabled)C_PlayerCache.IsEnabled()C_PlayerCache.SetScanEnabled(enabled)C_PlayerCache.IsScanEnabled()
-
GetSpellInfo(spellID)/GetSpellInfo(slot, bookType)C_Spell.GetSpellInfo(spellID)C_Spell.GetSpellName(spellID)C_Spell.GetSpellTexture(spellID)FindSpellBookSlotByID(spellID)GetSpellLink(spellID)/GetSpellLink(slot, bookType)C_Spell.GetSpellLink(spellID)C_Spell.GetSpellDescription(spellID)C_Spell.GetSpellReagents(spellID)IsPassiveSpell(spellID)/IsPassiveSpell(slot, bookType)C_Spell.IsSpellPassive(spellID)IsPlayerSpell(spellID)IsSpellKnown(spellID, [isPet])IsUsableSpell(spell)/IsUsableSpell(slot, bookType)C_Spell.IsSpellUsable(spellID)C_Spell.GetSpellCooldown(spellIdentifier)C_Spell.IsCurrentSpell(spellIdentifier)IsHarmfulSpell(spell)/IsHelpfulSpell(spell)C_Spell.IsSpellHarmful(spellID)/C_Spell.IsSpellHelpful(spellID)C_SpellBook.GetSpellLevelLearned(spellID)C_SpellBook.GetCurrentLevelSpells([level])C_SpellBook.GetSpellSkillLine(spellID)GetSpellSchool(spellID)CastSpellNoToggle(name | spellID)C_Spell.CancelSpellByID(spellID)/CancelSpellByName(name)
-
GetServerTime()C_Timer.After(seconds, callback)C_Timer.NewTimer(seconds, callback)C_Timer.NewTicker(seconds, callback, [iterations])C_DateAndTimeoverviewC_DateAndTime.GetCurrentCalendarTime()C_DateAndTime.GetCalendarTimeFromEpoch(epoch)C_DateAndTime.AdjustTimeByDays(date, days)/AdjustTimeByMinutes(date, minutes)C_DateAndTime.CompareCalendarTime(lhs, rhs)C_DateAndTime.GetServerTimeLocal()C_DateAndTime.GetSecondsUntilDailyReset()
-
UnitGUID(unit)UnitTokenFromGUID(guid)GetUnitSpeed(unit)UnitClassBase(unit)UnitRaceBase(unit)UnitIsAFK(unit)UnitIsDND(unit)UnitIsFeignDeath(unit)UnitIsInMyGuild(unitOrName)UnitIsPossessed(unit)UnitStandState(unit)UnitInRange(unit)UnitPower(unit [, powerType])/UnitPowerMax(unit [, powerType])UnitPowerType(unit)
-
C_UnitAuras.GetAuraDataByIndex(unit, index [, filter])C_UnitAuras.GetBuffDataByIndex(unit, index)/GetDebuffDataByIndex(unit, index)C_UnitAuras.GetUnitAuraBySpellID(unit, spellID [, filter])C_UnitAuras.GetPlayerAuraBySpellID(spellID)C_UnitAuras.GetAuraDataBySpellName(unit, spellName [, filter])C_UnitAuras.GetUnitAuras(unit [, filter])C_UnitAuras.GetAuraDispelTypeColor(dispelName)
Action
GetActionInfo(slot)
Returns the action descriptor for a 1-based action-bar slot, in the
shape actionType, id, subType. Returns nil for empty slots.
local actionType, id, subType = GetActionInfo(1)
| Slot contents | Returns |
|---|---|
| empty | nil |
| spell | "spell", spellID, "spell" |
| macro | "macro", macroSlot |
| item (by-itemID) | "item", itemID |
| item (by bag-instance) | "item", nil |
The 120-slot action table at 0x00BC6980 packs each entry as a
uint32 where the top 4 bits are the type tag:
0x0— spell action. Entry is the spellID. The third return is always"spell"for entries on this table; the engine helper hardcodes pet flag to 0 here. Pet-bar actions live in a separate table — usePetHasActionBar+ the pet-action helpers for pet slots.0x4— macro or bag-item. Ambiguous tag, disambiguated by walking the 36-entry macro-slot map at0x00BDCC60and checking whetherentry & 0xBFFFFFFFmatches any of those macro IDs. On a hit, the slot is a macro and the matching index becomes the 1-basedmacroSlotreturn. On a miss, the slot is a bag-item reference; we surface the type as"item"but returnnilfor theid— extracting the itemID from the bag-action hash struct needs more reversing than we've done.0x8— item by itemID.entry & 0x7FFFFFFFis the itemID.
This is the same discrimination SuperWoWhook uses in
its replacement of GetActionText (which returns name, type, id).
Without SuperWoWhook the engine's stock GetActionText only handles
items in bags; ClassicAPI's GetActionInfo provides the modern-WoW
shape independently of any other DLL patches.
Equivalent to the function of the same name in retail. Subtype is
always "spell" for spell entries (no pet differentiation on this
table) and the bag-item itemID path is currently incomplete — see
the comment in src/action/Info.cpp.
AddOns
Six modern C_AddOns.* getters that splat the legacy
GetAddOnInfo(arg) 7-tuple (name, title, notes, enabled, loadable, reason, security) into single-field accessors. Most
bypass GetAddOnInfo entirely and call the engine's per-field
helpers directly.
All accept either a 1-based index (1..GetNumAddOns()) or an
addon directory name string.
C_AddOns.GetAddOnName(indexOrName)
Returns the addon's directory name as the engine sees it (the
folder name on disk). For numeric input, returns the engine's
canonical casing; for string input, echoes the input verbatim
once existence is confirmed. Returns nil for missing addons.
C_AddOns.GetAddOnName(1) -- "Atlas-TW"
C_AddOns.GetAddOnName("DebugTools") -- "DebugTools"
C_AddOns.GetAddOnName("garbage") -- nil
C_AddOns.GetAddOnTitle(indexOrName)
Returns the ## Title: from the addon's .toc file, with WoW
color-code escapes applied. nil for missing addons or addons
without a title field.
C_AddOns.GetAddOnTitle("DebugTools") -- "UI Debug Tools"
C_AddOns.GetAddOnNotes(indexOrName)
Returns the ## Notes: from the .toc. nil for missing
addons or addons without notes.
C_AddOns.GetAddOnNotes("DebugTools")
-- "Tools for developing addons (backport of Blizzard_DebugTools 3.3.5 to 1.12.1 / Lua 5.0)"
C_AddOns.IsAddOnLoadable(indexOrName)
Returns loadable, reason — a real boolean and a status string
(or nil).
reason comes from a small status table the engine consults when
populating GetAddOnInfo's 6th return: "DISABLED", "BANNED",
"CORRUPT", "INSECURE", "NOT_DEMAND_LOADED",
"INTERFACE_VERSION", "MISSING". nil when the addon is
loadable. The full modern signature accepts optional character
and demandLoaded arguments — those are ignored here since vanilla
1.12 has no per-character addon enable state.
C_AddOns.IsAddOnLoadable("DebugTools") -- true, nil
C_AddOns.IsAddOnLoadable("HardcoreTooltips") -- false, "DISABLED"
C_AddOns.IsAddOnLoadable("garbage") -- false, nil
C_AddOns.GetAddOnSecurity(indexOrName)
Returns an Enum.AddOnSecurityStatus integer (not a string — modern
shape):
| Value | Enum.AddOnSecurityStatus.* |
When |
|---|---|---|
0 |
Secure |
Blizzard-signed addons (Blizzard_*). |
1 |
Insecure |
Every user addon loaded from Interface/AddOns/. The default for any registered addon not in the secure or banned override sets. |
2 |
Banned |
Entries the engine has explicitly disqualified — set by server addon-banlist responses, rare in practice. |
3 |
NotAvailable |
No addon by that name / index exists. |
C_AddOns.GetAddOnSecurity("Blizzard_TalentUI") -- 0 (Secure)
C_AddOns.GetAddOnSecurity("DebugTools") -- 1 (Insecure)
C_AddOns.GetAddOnSecurity("Nonexistent") -- 3 (NotAvailable)
if status == Enum.AddOnSecurityStatus.Secure then ...
C_AddOns.DoesAddOnExist(indexOrName)
Returns true iff the engine's addon registry has a matching
entry, false otherwise. Cheap existence probe used by addons
doing soft-dependency checks.
The implementation goes through the registry directly rather than
dispatching to GetAddOnInfo — the engine echoes its input name
back as ret1 unconditionally (before the lookup), so a
GetAddOnInfo("garbage") ~= nil heuristic returns true for any
string. This wrapper avoids that.
C_AddOns.DoesAddOnExist("DebugTools") -- true
C_AddOns.DoesAddOnExist("garbage") -- false
CharacterList
GetSavedCharacterOrder(realm) / SetSavedCharacterOrder(realm, order) — GlueXML only
Persists a user-chosen ordering for the character-select list, per realm, per account. Designed for GlueXML mods that add drag-to-reorder to the character-select screen — but since the storage is a plain text file you can also pre-populate it by hand.
Only callable from the login / character-select screens (the "glue" Lua state). Calling them from an in-world addon errors with "attempt to call nil" — they aren't registered there.
GetSavedCharacterOrder(realm)— returns the saved order forrealmas a string, or""if none has been saved. Nevernil.SetSavedCharacterOrder(realm, order)— writes the order string. Pass""to clear the saved entry for that realm.
The order value is a pipe-delimited list of character names, e.g.
"Thrall|Jaina|Sylvanas". Names are matched case-sensitively against
what GetCharacterInfo returns.
Storage file
Saved to WTF\Account\<ACCOUNT>\ClassicAPI.txt, one line per realm:
CharacterOrder.Octo=Thrall|Jaina|Sylvanas
CharacterOrder.AnotherRealm=Foo|Bar
<ACCOUNT> is the account name the launcher logged in with
(uppercase, the same folder name WoW uses for SavedVariables). The
realm key on each line is whatever string was passed as realm —
typically the result of GetServerName(). This file is shared with
other ClassicAPI account-scoped settings, so don't be surprised to
see unrelated Key=Value lines in it; leave them alone.
You can pre-populate the file by hand if you don't have a GlueXML mod
that calls SetSavedCharacterOrder. Just create or edit
ClassicAPI.txt in the correct account folder before launching the
game — any GlueXML code that reads GetSavedCharacterOrder(realm)
will see your saved order.
Addon example
-- GlueXML, e.g. CharacterSelect.lua: persist the user's drag-reordered list
local realm = GetServerName() or ""
local names = {}
for i = 1, GetNumCharacters() do
table.insert(names, (GetCharacterInfo(translationTable[i])))
end
SetSavedCharacterOrder(realm, table.concat(names, "|"))
-- On the next CHARACTER_LIST_UPDATE: read the saved order back
local saved = GetSavedCharacterOrder(realm)
if saved ~= "" then
for name in string.gfind(saved, "([^|]+)") do
-- reconcile against the current GetCharacterInfo names
end
end
Chat
GetCurrentChatGUID()
Returns the sender's GUID for whichever CHAT_MSG_* event is
currently being dispatched, or nil if called outside a chat
event or for a synthetic chat with no real sender (e.g.
CHAT_MSG_SYSTEM).
Format matches UnitGUID: "0xHHHHHHHHLLLLLLLL" (16 hex digits,
hi dword first).
local f = CreateFrame("Frame")
f:RegisterEvent("CHAT_MSG_CHANNEL")
f:RegisterEvent("CHAT_MSG_SAY")
f:RegisterEvent("CHAT_MSG_WHISPER")
f:SetScript("OnEvent", function()
local guid = GetCurrentChatGUID()
if guid then
local _, class, _, race = GetPlayerInfoByGUID(guid)
DEFAULT_CHAT_FRAME:AddMessage(string.format(
"%s: %s [%s %s]", arg2, arg1, class or "?", race or "?"))
end
end)
Vanilla 1.12's CHAT_MSG_* events don't include the sender GUID
in their payload — that was added in 3.0+ as arg12. Addons that
need to identify chatters reliably (rather than by sender name,
which is locale-fragile and ambiguous across realms) currently
strcmp against an addon-maintained name cache. This function lets
them skip that work.
Implementation: hooks the engine's chat dispatcher at
FUN_CHAT_DISPATCH (0x0049A870), which receives the sender
GUID as args 11/12 of a 12-arg __fastcall. The hook stashes the
GUID into a static global before forwarding to the original
function; the engine then fires the appropriate CHAT_MSG_*
event synchronously inside that window, so GetCurrentChatGUID()
called from the addon's OnEvent sees the right GUID. The global
is restored to its prior value (not cleared) on hook return, so
nested chat dispatch (e.g. an addon calling SendChatMessage
from its handler) doesn't lose the outer context's GUID.
The function returns nil rather than "0x0000000000000000"
for synthetic chat (system messages, login banners, etc.) where
the GUID args are zero — matches the idiomatic
if GetCurrentChatGUID() then check.
Class
FillLocalizedClassList(table [, isFemale])
Fills the passed-in table with [classToken] = localizedClassName
pairs for every class in ChrClasses.dbc, and returns the same
table for chaining.
The table is mutated in place. Existing keys are overwritten; unrelated keys are preserved.
local classes = FillLocalizedClassList({})
-- classes.WARRIOR = "Warrior"
-- classes.MAGE = "Mage"
-- classes.PRIEST = "Priest"
-- ...
Modern API supports an optional isFemale boolean to fetch female-
form names. Vanilla 1.12 has no separate female-name array in
ChrClasses.dbc — Name[9] (one localized string per locale)
sits exactly between offsets +0x14 and +0x38, with the class
token immediately after, leaving no room. The arg is accepted for
signature parity but ignored; the same names are returned either way.
Most locales (English included) wouldn't differentiate the two
anyway, so callers won't typically notice.
Sparse class IDs (vanilla skips classID 6 — Death Knight didn't exist yet — and a few others) have NULL records and are silently skipped.
Combat
InCombatLockdown()
Returns true if the local player is currently in combat, false
otherwise. Modern WoW gates secure-frame UI manipulation on this; 1.12
has no secure-frame system, so the function reduces to a plain
"is the player in combat" check. Useful for addons backporting modern
code that does e.g. if not InCombatLockdown() then SetBindingClick(...) end.
if not InCombatLockdown() then
-- safe to make UI changes
end
Equivalent to UnitAffectingCombat("player") but faster — reads the
UNIT_FLAG_IN_COMBAT bit directly off the player CGUnit's
m_objectFields, no token-resolution roundtrip.
Container
C_Container.GetContainerItemID(bagIndex, slotIndex)
Returns the itemID at the given bag/slot, or nil if the slot is empty
or the indices are out of range. Modern positional-arg form of the same
lookup C_Item.GetItemID({bagID=B, slotIndex=S}) performs.
bagIndex = 0— the player's main backpack.bagIndex = 1..4— the player's equipped bag slots.slotIndex— 1-based, capped at the bag's actual slot count (the engine'sPackBagSlotrejects out-of-range slots and returns nil cleanly).
for slot = 1, 16 do
local id = C_Container.GetContainerItemID(0, slot)
if id then
local _, type, subtype = C_Item.GetItemInfoInstant(id)
-- ...
end
end
GetItemCooldown(itemInfo) / C_Container.GetItemCooldown(itemID)
Returns (startTime, duration, enable) for the cooldown of the
spell triggered by the item's ON_USE effect. Direct-by-ID variant of
vanilla's GetContainerItemCooldown(bag, slot) — no slot reference
required.
-- Hearthstone (6948), right after using it:
/dump GetItemCooldown(6948)
-- 732120.014, 3600, 1 (startTime in GetTime() seconds, 60 min duration, ready)
-- Item with no ON_USE effect (or invalid itemID) returns all zeros.
/dump GetItemCooldown(2589) -- Linen Cloth → 0, 0, 0
| Field | Notes |
|---|---|
startTime |
GetTime()-compatible seconds when the cooldown started. 0 if no cooldown. |
duration |
Cooldown length in seconds. 0 if no cooldown. |
enable |
1 for "ready or counting down" (normal state); 0 for "used but cooldown hasn't started yet" (the potion-in-combat case). |
Input shapes:
GetItemCooldown(itemInfo)— accepts itemID,item:N/ chat-link hyperlink, numeric string, or item name (resolved via the sharedItem::Arghelper, same chainC_Item.GetItemCountetc. use).C_Container.GetItemCooldown(itemID)— modern signature accepts number / hyperlink but not spell name (per Blizzard's spec "will not accept an itemlink or name", but link parsing falls out of the sharedItem::Arg::Resolvefor free, so we accept it).
Routes through FUN_ITEM_QUERY_COOLDOWN (0x006E2ED0) which finds
the item's ON_USE spell slot in its ItemStats_C record and queries
that spell's cooldown via the same manager player-spell cooldowns
use.
C_Container.GetContainerItemDurability(containerIndex, slotIndex)
Bag/bank variant of GetInventoryItemDurability.
Same (current, maximum) return shape and the same "nothing for items
without durability" rule.
current, maximum = C_Container.GetContainerItemDurability(containerIndex, slotIndex)
containerIndex = 0— the player's main backpack.containerIndex = 1..4— the player's equipped bag slots.containerIndex = -1, 5..11— bank-frame slots, only addressable while the bank window is open.slotIndex— 1-based, capped at the bag's actual slot count.
for slot = 1, GetContainerNumSlots(0) do
local cur, max = C_Container.GetContainerItemDurability(0, slot)
if cur then
-- item at backpack slot has durability
end
end
Goes through the same bag-resolve chain
C_Container.GetContainerItemID
uses (engine's PackBagSlot → GetItemBySlot), then reads the same
durability fields off the descriptor.
C_Container.GetContainerItemRepairCost(containerIndex, slotIndex)
Bag/bank variant of
GetInventoryItemRepairCost.
Same copperCost single-int return and the same "0 for nothing to
repair" semantics.
copperCost = C_Container.GetContainerItemRepairCost(containerIndex, slotIndex)
containerIndex accepts the same values as
C_Container.GetContainerItemDurability
(0 = backpack, 1..4 = equipped bags, -1/5..11 = bank, etc.).
for slot = 1, GetContainerNumSlots(0) do
local cost = C_Container.GetContainerItemRepairCost(0, slot)
if cost > 0 then
-- broken/damaged item sitting in the backpack
end
end
Useful for "repair only items above N copper" smart-repair logic without scanning tooltips. ClassicAPI addition; modern WoW has no direct equivalent.
C_Container.GetContainerNumFreeSlots(bagID)
Returns the number of empty slots in the given bag, plus the bag's
BagFamily bitfield (the type of items the bag is restricted to).
numberOfFreeSlots, bagType = C_Container.GetContainerNumFreeSlots(bagID)
bagID = 0— the player's main backpack. Always reports(freeCount, 0)— the backpack is unfamilied (general-purpose).bagID = 1..4— the player's equipped bag slots. Slot count and bagType come from the bag item's cachedItemStats_Crecord —m_containerSlotsandm_bagFamilyrespectively. If no bag is equipped (or the item somehow isn't cached):(0, 0).- Other
bagIDvalues (bank, keyring, out-of-range):(0, 0). Always returns two values, never nil.
local free, bagType = C_Container.GetContainerNumFreeSlots(0)
-- free = number of empty slots in backpack, bagType = 0
for bag = 0, 4 do
local free = C_Container.GetContainerNumFreeSlots(bag)
-- ...
end
Vanilla
bagTypeis sparse. On Turtle WoW (1.12.1), only Light Quiver actually carries a populated BagFamily field among the bags we tested. Soul Pouch, Enchanting Bag, Herb Pouch, etc. all return 0 here even though their classification clearly implies a family — the vanilla server data simply doesn't fill the field for those. For bag-category discrimination, prefer reading(class, subClass)fromC_Item.GetItemInfoInstant. The same field on individual loot items (arrows, bullets, shards, herbs) IS populated reliably — useC_Item.GetItemFamilyfor routing decisions.
The bitmask encoding matches modern.
bagTypeis the bit position (1 << (familyID - 1)), not the raw 1.12-stored familyID, so callers can bitwise-AND with itemFamily values fromC_Item.GetItemFamilydirectly. We convert internally — see that function's notes for the encoding-shift story.
Implementation walks the bag using
Item::Location::ResolveBag
internally and counts slots that resolve to a null CGItem * (i.e.,
empty). Cross-checked in-game against a manual
C_Container.GetContainerItemID walk; counts match.
C_Container.PlayerHasHearthstone()
Returns the itemID of the hearthstone if one is in the player's bags,
or nil otherwise.
itemID = C_Container.PlayerHasHearthstone()
if C_Container.PlayerHasHearthstone() then
-- player can hearth
end
Match logic. An item counts as a hearthstone if either:
- Its itemID is
6948(the vanilla Hearthstone — fast path, no cache lookup needed), or - Its on-use spell is spell
8690(the "Hearthstone" cast itself).
Rule 2 lets custom servers (Turtle WoW, etc.) ship reskinned
hearthstone items with different itemIDs and still have them
recognized — as long as their on-use is the Hearthstone spell.
The return is the actual matched itemID, not a hardcoded
constant, so code that wants to do something with the found id
(SetItemRef for chat-linking, GetItemInfo for the item's
name, etc.) gets the right value for any variant.
Cache dependency for rule 2. The on-use-spell check requires the item's
ItemStats_Crecord to be in the local cache. Items currently in the player's bags are always cached (the engine pre-fills the cache during bag sync), so the check is reliable for this code path. The fallback to rule 1 (vanilla itemID equality) covers the moment-of-login window before the cache is fully populated.
Walks bags 0..4 via the same chain
C_Container.GetContainerItemID
uses internally. Stops on first match.
C_Container.UseHearthstone()
Locates the hearthstone in bags and uses it. Returns true if the
hearthstone was found and the use call dispatched, false if no
hearthstone is in bags.
used = C_Container.UseHearthstone()
if not C_Container.UseHearthstone() then
print("No hearthstone in bags!")
end
truedoesn't guarantee the cast started. The return reflects "we had a hearthstone to try with and called the engine'sUseContainerItemon it." Whether the cast actually starts depends on cooldown, combat, movement, etc. — same downstream rules as callingUseContainerItem(bag, slot)manually. If you need to know whether the hearth completed, listen for the appropriate cast events (SPELLCAST_START/SPELLCAST_STOP).
Internally locates the hearthstone with the same walk
PlayerHasHearthstone uses and hands the resulting CGItem * pointer
to the engine's by-pointer use primitive at 0x005D8D00 — the same
fallback path Script_UseContainerItem ends up at after every special
cursor-mode branch (repair vendor, spell-cast targeting, drop-on-bag)
is skipped. Bypassing the dispatcher avoids the Lua-stack roundtrip
of pushing (bag, slot) only for Script_UseContainerItem to re-parse
and re-resolve the same item.
C_Container.SwapItems(srcBag, srcSlot, dstBag, dstSlot)
Atomically swaps two bag slots on the server, no cursor involved.
Returns true on send, false for bad args (missing bag, out-of-range
slot, empty source).
-- Move slot 3 of bag 1 to slot 7 of the backpack
C_Container.SwapItems(1, 3, 0, 7)
-- Swap two backpack slots
C_Container.SwapItems(0, 1, 0, 2)
Bag IDs match the rest of C_Container.*: 0 is the backpack, 1..4
are the equipped bags. Slots are 1-based. The engine accepts both
directions:
- Same container (e.g. backpack ↔ backpack, bag1 ↔ bag1) sends opcode
0x10DCMSG_SWAP_INV_ITEMwith the two linear slot bytes. - Cross-container (e.g. backpack ↔ bag1, bag2 ↔ bag3) sends opcode
0x10CCMSG_SWAP_ITEMwith(srcBag, srcSlot, dstBag, dstSlot).
Destination empty becomes a move; destination occupied becomes an atomic swap.
ClassicAPI-only. Modern Classic Era has no direct swap-two-slots call — addons there drive the cursor with two
PickupContainerItemcalls in sequence. This single-call form bypasses the cursor entirely (same pathC_EquipmentSet.UseEquipmentSetuses for its swap chain).
Send is fire-and-forget. Server confirms via the normal
BAG_UPDATE / SMSG_INVENTORY_CHANGE_FAILURE flow; this call does not
wait for that round-trip.
C_Container.MoveItem(srcBag, srcSlot, dstBag, dstSlot, count)
Atomic split-and-place: move exactly count items from src to dst,
no cursor involvement. Returns true on send, false on bad args
(missing bag, out-of-range slot, empty source, count < 1, or
count > 255).
-- Split 5 items off backpack slot 1 into backpack slot 2
C_Container.MoveItem(0, 1, 0, 2, 5)
-- Top up a partial stack by moving 3 items from another stack
C_Container.MoveItem(1, 4, 0, 7, 3)
Server semantics are all-or-nothing — vanilla has no partial-move form:
dstempty → placescountthere (clean split).dstholds the same item &dstCount + count ≤ maxStack→ mergescountinto dst.dstholds a different item, or the merge would overflow → server rejects entirely (source untouched,SMSG_INVENTORY_CHANGE_FAILUREfires).
Use this instead of C_Container.SwapItems when you want to
consolidate partial stacks — SwapItems swaps the whole slots, which
isn't what you want when both slots hold the same item but one has a
partial stack.
vs. the modern equivalent. Modern Classic Era has no direct one-call move — addons there string
SplitContainerItem(bag, slot, count)+PickupContainerItem(dstBag, dstSlot)together to drive the cursor. This bundles the same two-step into one packet (CMSG_SPLIT_ITEM, opcode 0x10E), so the cursor is never touched.
Send is fire-and-forget (same as SwapItems).
C_Item.UseItemByName(itemInfo)
Finds the first item in the player's bags matching itemInfo and
uses it. Returns nothing; silently no-ops when:
- the input is
nil, an empty string, or otherwise unparseable - no matching item is in bags
- the engine refuses the use — cooldown, locked item, level requirement, etc.
itemInfo accepts the same shapes as
C_Item.EquipItemByName —
itemID number, bare "item:N" string, full chat link, or a localized
item name. Name matches are case-insensitive against the cached
m_name[0].
C_Item.UseItemByName("Hearthstone") -- hearth home
C_Item.UseItemByName(6948) -- same thing, by ID
C_Item.UseItemByName("Major Healing Potion")
Mirrors 3.3.5's Script_UseItemByName structure: locate the item
directly, then hand the CGItem * to the engine's by-pointer use
primitive at 0x005D8D00. That primitive dispatches internally based
on item type (food, potion, on-use spell, scroll, quiver, ...) so a
single call covers every item category. We skip
Script_UseContainerItem entirely — its branches for repair vendor,
spell-cast targeting, and drop-on-bag cursor modes don't apply to an
addon-issued call from a clean cursor.
For target-required items (scrolls, traps), the engine reads
cursor-target state at call time, which a Lua-side caller can pre-set
with TargetUnit("..."). For self-use items (hearthstone, potions,
food) the engine substitutes the player even if a different target is
present, so no pre-setup is needed.
CVar
C_CVar.GetCVarBool(cvar)
Returns the cvar's value coerced to a boolean, or nil if no cvar
by that name is registered. The C_CVar namespace was added in
10.x; vanilla 1.12 only has GetCVar which returns a string.
C_CVar.GetCVarBool("gxMaximize") -- true if the window is set fullscreen
C_CVar.GetCVarBool("CombatDamage") -- false if floating damage text is off
C_CVar.GetCVarBool("doesNotExist") -- nil — distinguishable from false
Coercion rules (only applied when the cvar exists):
| Cvar string value | Result |
|---|---|
"1" or any non-zero numeric ("42", "-3", …) |
true |
"true" (case-insensitive) |
true |
"0" or empty |
false |
Non-numeric, non-"true" ("on", "yes") |
false |
| Cvar name not registered | nil |
Implementation reads the cvar registry directly (engine's
FUN_FIND_CVAR at 0x0063DEC0), bypassing GetCVar's Lua-error
path for unknown cvars. The nil return lets callers distinguish
"the cvar exists and is falsy" from "no such cvar."
Glue-state availability
C_CVar.GetCVarBool is also registered on the glue Lua state, and
the engine's stock GetCVar / SetCVar / RegisterCVar /
GetCVarDefault — which vanilla 1.12 only exposes in-game — are
mirrored onto glue too. GlueXML patches at the login / realm /
char-select screens can now read and write CVars directly. CVar
storage is process-global, so writes on either state are
immediately visible on the other (a SetCVar("foo", "1") from a
GlueXML script will read back as "1" on the in-world side, and
vice versa).
EquipmentSet
Backports the modern C_EquipmentSet.* namespace on top of a
client-side persistent store. Vanilla 1.12 had no equipment-set
functionality at all (Blizzard introduced it in 3.1.2 as
SaveEquipmentSet etc., then namespaced it into C_EquipmentSet in
Legion) — and even when it shipped natively, the data lived
server-side, synced via SMSG_EQUIPMENT_SET_LIST. Vanilla servers
don't speak that opcode and won't ever, so each character's sets are
kept in a per-character file under WTF\Account\.... The format
matches what VanillaMinimapTracking does for its tracking config.
Overview & file format
Sets are stored in
WTF\Account\<account>\<realm>\<character>\ClassicAPI_EquipmentSets.txt
in a line-oriented, human-readable format:
# ClassicAPI Equipment Sets v1
set 1
name=Tanking
icon=INV_Shield_06
slot 1 guid=0x0000000040000123
slot 2 ignored
slot 5 guid=0x0000000040000789
set 2
name=Healing
icon=Spell_Holy_HolyBolt
...
Identity is by item GUID, snapshotted at CreateEquipmentSet /
SaveEquipmentSet time. UseEquipmentSet searches every player-owned
container for those GUIDs and dispatches pickup→equip pairs for items
that aren't already where they belong. The search reads the
underlying GUID arrays directly (same trick C_Item.GetItemCount
uses for its includeBank=true path), so bank items resolve even
without the bank window being open — the bank gate at
VAR_BANK_GATE_GUID only suppresses GetItemBySlot, not the
underlying data.
One limitation worth knowing about:
- Equipping from the bank is not supported by vanilla's protocol
—
UseEquipmentSetskips bank items rather than try and fail. Retrieve the items first, then re-run.
Modern's signatures take a numeric iconFileID; we accept icon path
strings (e.g. "INV_Shield_06") since vanilla has no fileDataID
system. Same string-or-default fallback semantic as 4.3.4 native.
Cap is 10 sets per character, matching 4.3.4. The full list re- serializes on every mutation; a corrupted file is harmless (parse errors leave the in-memory list empty and the next save rewrites the file from scratch).
Note: this is a fresh client-side namespace, not a polyfill of some specific Blizzard build's behavior. The shape mirrors Classic Era 1.15.x's
C_EquipmentSet.*where it can, but anything that requires server-side state (cross-character sharing, the "Equipment Manager" specialization tab) isn't supported.
C_EquipmentSet.CanUseEquipmentSets()
Returns true unconditionally. Vanilla has no banker/feature gate
on equipment-set storage; we ship the feature for every character.
Equivalent to Classic Era's behavior.
C_EquipmentSet.GetNumEquipmentSets()
Returns the count of sets stored for the current character. Loads the file on first call after login.
C_EquipmentSet.GetEquipmentSetIDs()
Returns a numeric-keyed table of every setID in storage order (insertion-order; not alphabetical). Empty table when nothing's saved.
C_EquipmentSet.GetEquipmentSetID(name)
Returns the numeric setID for a set with the given name, or nil if
no set by that name exists. Names are exact (case-sensitive, no
trimming).
C_EquipmentSet.GetEquipmentSetInfo(setID)
Returns the nine values modern ships:
name, icon, setID, isEquipped,
numItems, numEquipped, numInInventory, numMissing, numIgnored
isEquipped is true when every resolvable item in the set is in
its target slot (missing items don't disqualify — useful so a set
that includes a bank-stored cloak still shows as equipped after you
swap in the rest). numItems excludes ignored slots; numIgnored
counts them separately. Returns nothing for an unknown setID.
C_EquipmentSet.GetIgnoredSlots(setID)
Returns a numeric-keyed table of slot indices (1..19) that the set
has flagged ignored. Empty table when no slots are ignored. Ignored
slots are recorded per-set at save time, by reading the global
IgnoreSlotForSave state — not retroactively editable on a saved set.
C_EquipmentSet.GetItemIDs(setID)
Returns a hash table { [slot] = itemID } for every set slot whose
item is currently resolvable. Missing items (GUID stored but client
can't find a CGItem) are omitted because vanilla doesn't keep an
itemID separate from the live CGItem record.
C_EquipmentSet.GetItemLocations(setID)
Returns a hash table { [slot] = locationCode }. Location codes use
the same bit-packed encoding Blizzard's FrameXML
EquipmentManager_UnpackLocation decodes (constants in
Blizzard_FrameXMLBase/Classic/Constants.lua):
| Bit/field | Meaning |
|---|---|
0x00100000 (PLAYER) |
Item is in a player slot (equipped or in a player bag) |
0x00200000 (BAGS) |
Item is inside a bag (player or bank) |
0x00400000 (BANK) |
Item is in the bank (main or bank bag) |
| bits 0..7 | Slot (1-based) within the container |
| bits 8..15 | Bag index — present only when BAGS bit is set |
PLAYER and BANK are mutually exclusive in the encoding (the
unpack uses if player elseif bank). Bank bags subtract 4 from the
bagID before storing so the field fits cleanly; unpack reverses this
to give back bag IDs 5..10. Composition:
| Location | Bits | Example |
|---|---|---|
| Equipped (paperdoll slot 1..19) | `PLAYER | slot` |
| Backpack / player bag 1..4 | `PLAYER | BAGS |
| Main bank slot 1..28 | `BANK | slot` |
| Bank bag 5..10 | `BANK | BAGS |
Special values returned in the table entry:
1— slot is ignored (GetIgnoredSlotslists these)-1— item is missing (was in the set, can't find now)
The packed codes pass cleanly through Blizzard's
EquipmentManager_UnpackLocation if you want to use the
shared-FrameXML helpers in your addon UI.
C_EquipmentSet.CreateEquipmentSet(name [, icon])
Snapshots the player's currently-equipped items into a new set and
returns its setID. Honors IgnoreSlotForSave — slots flagged ignored
at call time get the ignored marker instead of the equipped item's
GUID.
Returns the new setID on success. Returns nothing if:
- the name is empty or already in use
- the cap of 10 sets is reached
icon defaults to "INV_Misc_QuestionMark" if omitted.
C_EquipmentSet.SaveEquipmentSet(setID [, icon])
Overwrites an existing set's contents with the player's currently-
equipped items. Same ignored-slot handling as CreateEquipmentSet.
If icon is provided it replaces the set's previous icon; otherwise
the icon is left unchanged.
C_EquipmentSet.ModifyEquipmentSet(setID, newName)
Renames an existing set. Fails silently if the new name is empty, already in use by a different set, or the setID doesn't exist.
C_EquipmentSet.DeleteEquipmentSet(setID)
Removes the set. SetIDs are not reused — the next Create call
allocates one higher than any seen.
C_EquipmentSet.IgnoreSlotForSave(slot) / UnignoreSlotForSave / IsSlotIgnoredForSave / ClearIgnoredSlotsForSave
Global "skip this slot the next time CreateEquipmentSet or
SaveEquipmentSet runs" state, indexed by 1-based slot (1..19).
Persists for the rest of the session; not written to the WTF file.
Use it when building a set that should leave (say) the tabard slot
free — set the ignore flag, then call CreateEquipmentSet, then
optionally ClearIgnoredSlotsForSave() afterward.
C_EquipmentSet.EquipmentSetContainsLockedItems(setID)
Returns true if any item in the set is currently flagged "locked"
by the engine — a pending pickup or use is in flight that
UseEquipmentSet would race with. Reads bit 2 (0x04) of
ITEM_FIELD_FLAGS for each resolvable item in the set.
C_EquipmentSet.UseEquipmentSet(setID)
Walks the set and dispatches one atomic server-side swap per item
that isn't already in its target slot. Items in the bank are skipped
silently (vanilla can't equip from bank). Missing items are skipped
silently. Returns true if the call ran (the set existed), false
otherwise.
Implementation uses the same FUN_INVENTORY_SWAP primitive
C_Item.EquipItemByName
uses for its explicit-slot path. Each swap is a single
CMSG_SWAP_INV_ITEM (or CMSG_AUTOEQUIP_ITEM) packet that the server
applies atomically — the two-cycle "ring A in slot 11, ring B in
slot 12, set swaps them" case resolves in one packet because the
opcode swaps both slots in a single server transaction. The cursor
is never touched; an item held on the cursor when
UseEquipmentSet is called stays on the cursor.
Longer dependency chains (3+ items rotating) are rare with 1.12's slot set — the realistic conflicts are paired slots (rings 11/12, trinkets 13/14, weapons 16/17), all 2-cycles.
CURSOR_UPDATEfires per item moved. The engine's swap primitive (FUN_005E0C40) runs a generic cursor-state cleanup at the end of each call, which firesCURSOR_UPDATEregardless of whether the cursor was actually touched. So oneUseEquipmentSetcall that moves N items will fire NCURSOR_UPDATEevents in quick succession. Addons that react toCURSOR_UPDATE(cursor-attached tooltips, drag-state tracking) should debounce — or checkCursorHasItem()before doing work — since most of those fires won't reflect a real cursor change. This is engine behavior, not a bug in the implementation; the old cursor-based path actually fired more (one per pickup, one per equip, one per cursor-clear).
Events
C_EventUtils.IsEventValid(eventName)
Returns true if the named event exists in the engine's event-name table
and can be registered for, false otherwise. Equivalent to the modern
function of the same name; useful for addons that gate code behind feature
detection (e.g. registering for events that exist in some client builds
but not others).
if C_EventUtils.IsEventValid("PLAYER_LOGIN") then ... end -- true
if C_EventUtils.IsEventValid("COMBAT_LOG_EVENT") then ... end -- false (added in 3.x)
The check walks the engine's static event-name table at runtime, so it
sees events added by any loaded DLL that injects names by overwriting
.rdata strings in place — for example, on a Turtle WoW client running
SuperWoWhook, IsEventValid("UNIT_CASTEVENT") returns true because
SuperWoWhook patches the binary's event names with its own. This matches
what frame:RegisterEvent will actually accept, which is what addon code
needs to know.
BAG_UPDATE_DELAYED event
Fires (with no payload) once per frame in which any BAG_UPDATE
fired. Matches modern WoW's coalescing semantic exactly — register
for BAG_UPDATE_DELAYED instead of BAG_UPDATE and rescan once
per frame regardless of how many updates fired.
local f = CreateFrame("Frame")
f:RegisterEvent("BAG_UPDATE_DELAYED")
f:SetScript("OnEvent", function() RescanMyInventory() end)
A trade with 6 stacks (12 BAG_UPDATEs, all processed in one
frame) produces exactly 1 BAG_UPDATE_DELAYED at the end of the
frame — matches Classic Era 1.15.x's observed behavior.
Implemented by three hooks, none in regions other DLLs touch:
FUN_004F91A0/FUN_004F9370(bag subsystem at0x004F9xxx) — each just sets ag_pendingflag, no fireFUN_0066FD50(engine's per-frame world-subsystem update at0x0066xxxx, deep in the rendering pipeline, only one caller in the entire binary) — drains the flag at the tail of the world tick
The world-tick hook is a tail hook (run original first, then fire DELAYED), so the fire happens after every other per-frame world work completes. Addon callbacks see DELAYED after their normal event handlers.
Coverage limitation. The keyring
BAG_UPDATE(-2)path goes through a separate function (FUN_004F8DB0) that uses__thiscallwith an awkward register-arg shape. Keyring updates currently won't triggerBAG_UPDATE_DELAYED. Player bag (0..4) and bank (5..10) updates work normally — the 95% case.
HEARTHSTONE_BOUND event
Fires (with no payload) every time the player binds their
hearthstone at an innkeeper. Polyfills modern WoW's event of the
same name — addons listen to HEARTHSTONE_BOUND and re-read
GetBindLocation() to refresh whatever bind-location UI they show.
local f = CreateFrame("Frame")
f:RegisterEvent("HEARTHSTONE_BOUND")
f:SetScript("OnEvent", function()
local newLocation = GetBindLocation()
-- update UI...
end)
Fires every time the player confirms a bind, including when the new bind is at the same inn as before. The event is driven by the bind ACTION (server's SMSG_BINDPOINTUPDATE), not by the area name changing — matches modern semantics.
Implemented by hooking the BINDPOINTUPDATE packet handler at
FUN_005ED3C0. The handler runs in two distinct cases:
- Initial post-login sync — the engine has just zeroed the
"bind valid" flag during character-entry init (
FUN_005E2510), and this packet repopulates it. We detect this by reading the flag before the original handler runs; if it's0, this is the sync and we suppress the event. - Innkeeper rebind — the flag is already
1. Fire.
Character switch is handled automatically: the character-entry init re-zeroes the flag, so each new character's first update is also treated as sync and suppressed.
Player input-state events
Three pairs of zero-payload events fired from a single per-frame
Tick::WorldTick callback that reads input state once and edge-
detects each pair.
| Event | Fires on | Source |
|---|---|---|
PLAYER_STARTED_MOVING / PLAYER_STOPPED_MOVING |
WASD or autorun toggle | UI-input controller flags at *0x00BE1148 + 0x04 (0x10 W | 0x20 S | 0x40 A | 0x80 D | 0x1000 autorun) |
PLAYER_STARTED_TURNING / PLAYER_STOPPED_TURNING |
Mouselook bit held AND character body yaw is changing | Mouselook bit 0x01 + per-frame delta on CGPlayer + 0x9C4 (body yaw, radians) |
PLAYER_STARTED_LOOKING / PLAYER_STOPPED_LOOKING |
Free-look bit held AND camera-relative yaw is changing | Free-look bit 0x02 + per-frame delta on [*0x00B4B2BC + 0x65B8] + 0xF0 (camera yaw, radians) |
local f = CreateFrame("Frame")
for _, ev in ipairs({
"PLAYER_STARTED_MOVING", "PLAYER_STOPPED_MOVING",
"PLAYER_STARTED_LOOKING", "PLAYER_STOPPED_LOOKING",
"PLAYER_STARTED_TURNING", "PLAYER_STOPPED_TURNING",
}) do
f:RegisterEvent(ev)
end
f:SetScript("OnEvent", function(_, event) print(event) end)
Key-state semantics for MOVING: STOPPED_MOVING fires the
instant the movement keys release, even if the character is still
airborne from a jump. Matches retail (verified empirically). For
an "is the character actually displacing this frame" signal, use
GetUnitSpeed("player") and watch the first return.
Latched semantics for TURNING and LOOKING: each pair fires exactly once per RMB / LMB hold. STARTED waits until both the mouse-button bit is held AND the relevant yaw has actually changed (matches retail's "camera has moved" semantics — clicking without dragging doesn't fire). STOPPED fires when the button bit clears (RMB / LMB release). The latch stays on through any drag- stop-drag motion within a single hold; no spurious flapping.
The camera-relative yaw at [camera + 0xF0] stays at 0 during
RMB-mouselook (camera rotates with the character, so its offset
from the character doesn't change), so TURNING and LOOKING are
cleanly separable: RMB only fires TURNING, LMB only fires LOOKING.
Implementation: single subscriber on the shared Tick::WorldTick
registry (same MinHook on FUN_0066FD50 shared with
BAG_UPDATE_DELAYED). When any of the input controller / player /
camera pointers is null (pre-login, loading screen, character
select), all states reset so the next valid tick doesn't fire
spurious STOPPED transitions.
GLOBAL_MOUSE_DOWN / GLOBAL_MOUSE_UP events
Fires on every raw mouse-button press or release while WoW has focus. Payload is the button identifier string — matches modern WoW's signature exactly.
local f = CreateFrame("Frame")
f:RegisterEvent("GLOBAL_MOUSE_DOWN")
f:RegisterEvent("GLOBAL_MOUSE_UP")
f:SetScript("OnEvent", function(_, event, button)
print(event, button) -- "GLOBAL_MOUSE_DOWN", "LeftButton"
end)
| Payload | Source |
|---|---|
"LeftButton" |
VK_LBUTTON |
"RightButton" |
VK_RBUTTON |
"MiddleButton" |
VK_MBUTTON |
"Button4" |
VK_XBUTTON1 |
"Button5" |
VK_XBUTTON2 |
Distinct from per-frame OnMouseDown scripts — these fire even
when the click misses every UI frame (clicks in the world / on
nothing). Distinct from PLAYER_STARTED_LOOKING /
PLAYER_STARTED_TURNING — those are camera-rotation events;
these are raw input events.
Focus-gated. Polls Win32 GetAsyncKeyState per frame on the
shared Tick::WorldTick registry. DOWN transitions are only
honored when WoW is the foreground window — clicking in another
app while alt-tabbed doesn't fire. UP transitions always fire,
even if the user alt-tabbed mid-click, so an addon never gets
left in a "button is held" state.
EQUIPMENT_SETS_CHANGED event
Fires (with no payload) after any mutation: Create, Save,
Modify, Delete, and the four *IgnoredSlot* calls. Addon UI
should re-read its set list / button state when this fires.
EQUIPMENT_SWAP_PENDING event
Fires with a single payload arg — setID — at the start of
UseEquipmentSet, right after the set-exists check passes and
before any pickup/equip work begins. Modern addons use this to
gate "swap in progress" UI state (grey out the set button, show
a spinner, etc.) until EQUIPMENT_SWAP_FINISHED arrives.
Doesn't fire if UseEquipmentSet is called with an unknown
setID — in that case only EQUIPMENT_SWAP_FINISHED(false, setID)
fires.
EQUIPMENT_SWAP_FINISHED event
Fires at the end of every UseEquipmentSet call with two payload
args: success (1 if the set existed and we dispatched the swap, 0
if the setID was unknown) and setID. Note this is "we ran the
dispatch" success — not "every item ended up in its target slot."
Items that were in the bank or that couldn't complete a swap cycle
in one pass still report success=1. Listen for this if you want to
re-paint the character pane / refresh tooltips after a swap.
FACTION_STANDING_CHANGED event
Fires once per reputation change with (factionID, newStanding, repGained):
| arg1 (factionID) | Faction.dbc row ID of the faction whose standing changed |
| arg2 (newStanding) | New total standing value (post-change barValue) |
| arg3 (repGained) | Signed delta — positive on gain, negative on loss |
Polyfills the modern event of the same name. Vanilla 1.12 exposes only
CHAT_MSG_COMBAT_FACTION_CHANGE, whose arg1 is the localized chat
string ("Your Stormwind reputation has increased by 100.") — addons
have to parse the text and reverse-resolve the faction name back to
an ID. This event lets addons skip that work.
Does not fire for the initial faction sync at login or /reload
— matches modern semantics. Only fires when a real reputation gain or
loss arrives from the server (SMSG_SET_FACTION_STANDING).
local f = CreateFrame("Frame")
f:RegisterEvent("FACTION_STANDING_CHANGED")
f:SetScript("OnEvent", function()
-- in vanilla 1.12 OnEvent receives no args; engine sets `event`
-- and `arg1..argN` as globals before invoking the handler.
if event == "FACTION_STANDING_CHANGED" then
local name = GetFactionInfoByID(arg1)
print(string.format("%s: %+d (now %d)", name, arg3, arg2))
end
end)
repGained is signed: positive for gains, negative for the rare loss
case (e.g. killing a Goblin Commodity Exchange NPC drops your rep
with Booty Bay).
Implementation notes
Hooks the engine's per-rep-change notify dispatcher at 0x0062C5F0
— the chokepoint called once per (factionID, signedDelta) from
the per-slot setter at 0x004D6330, gated by "value-actually-changed
AND notify-flag-set". The setter has already written the new delta
into the per-slot storage by the time the hook fires, so we read the
total back via FUN_REPUTATION_GET_STANDING(factionID) (0x004D6370)
to produce the newStanding payload.
The hook calls the original before firing our event so the engine's
CHAT_MSG_COMBAT_FACTION_CHANGE still fires first — no behavior
change for addons that depended on the chat text. A per-call
snapshot of (factionID, newStanding, repGained) is captured before
forwarding, which C_Reputation.GetLastStandingChange
exposes — so addons can read the structured payload from inside the
chat event without re-parsing the localized string.
MODIFIER_STATE_CHANGED event
Fires on every modifier-key press and release with (key, down):
| arg1 (key) | LSHIFT, RSHIFT, LCTRL, RCTRL, LALT, RALT |
| arg2 (down) | 1 on press, 0 on release |
Only transitions fire — key autorepeat does not. Matches 2.4.3+ semantics.
local f = CreateFrame("Frame")
f:RegisterEvent("MODIFIER_STATE_CHANGED")
f:SetScript("OnEvent", function()
-- in vanilla 1.12 OnEvent receives no args; engine sets `event` and
-- `arg1..argN` as globals before invoking the handler.
if event == "MODIFIER_STATE_CHANGED" and arg1 == "LSHIFT" then
print("left shift", arg2 == 1 and "down" or "up")
end
end)
Implementation notes
L/R modifier distinction doesn't exist anywhere in the 1.12 engine's
own state — its IsShiftKeyDown chain bottoms out at
GetKeyState(VK_SHIFT) (the merged virtual key, 0x10), never the
L/R-aware VK_LSHIFT / VK_RSHIFT. The OS-level keystate does have
the distinction; we capture it by installing a WH_GETMESSAGE Win32
thread hook on the engine's message-pump thread, decoding each
WM_KEY{,SYS}{DOWN,UP} message (using MapVirtualKeyA(scancode, MAPVK_VSC_TO_VK_EX) to resolve VK_SHIFT to L/R and the KF_EXTENDED
bit in lParam for VK_CONTROL / VK_MENU), and maintaining a
6-bit cached bitmap that the seven query functions read.
The thread-message hook is per-thread, not per-HWND — it survives
renderer-state changes that recreate WoW's main window (e.g. toggling
vertical sync), where an SetWindowLongPtr-style WNDPROC subclass
would be left dangling.
QUEST_ACCEPTED event
Fires once per quest the player just accepted, with two payload args:
the 1-based quest log index and the questID. Matches the Cata/WotLK
signature QUEST_ACCEPTED(questLogIndex, questID). Polyfills modern
WoW's event of the same name (added in 3.1.0).
local f = CreateFrame("Frame")
f:RegisterEvent("QUEST_ACCEPTED")
f:SetScript("OnEvent", function()
-- 1.12: event payload is in `arg1`, `arg2`, ... globals
if event == "QUEST_ACCEPTED" then
local questLogIndex, questID = arg1, arg2
-- ...
end
end)
Fires for every path that adds a quest to the local log — NPC accept,
party-shared quest accept, auto-grant from quest items — by hooking
the single engine chokepoint (FUN_QUEST_LOG_REBUILD at 0x004DE510)
that rebuilds the Lua-visible quest log from the player's
authoritative slot data after any quest state change.
Does not fire on initial login / character entry, even though the
same engine function runs the bulk-sync there. Suppression is
heuristic: if a single rebuild call adds more than one quest, it's
treated as a resync and skipped. Human input speed can't accept two
quests within the same engine tick, so single-add is always a real
user accept. A brand-new character's very first quest accept
(0 → 1 entries) fires correctly.
QUEST_TURNED_IN event
Fires when the server confirms a quest turn-in
(SMSG_QUESTGIVER_QUEST_COMPLETE, opcode 0x191). Payload
(questID, xpReward, moneyReward) matches modern WoW exactly —
xpReward is the experience awarded (0 at max level or for
non-XP-bearing quests), moneyReward is in copper.
local f = CreateFrame("Frame")
f:RegisterEvent("QUEST_TURNED_IN")
f:SetScript("OnEvent", function()
if event == "QUEST_TURNED_IN" then
local questID, xp, money = arg1, arg2, arg3
-- ...
end
end)
Polyfilled by hooking the per-opcode SMSG handler at FUN_005DC400
(found via the CMSG side: Script_GetQuestReward →
FUN_005015B0 → FUN_005EADC0 sends opcode 0x18E
CMSG_QUESTGIVER_CHOOSE_REWARD; SMSG response is opcode 0x191).
The hook saves the packet stream's read cursor (stream+0x14),
peeks the first 4 uint32s of the body (questID, unknown, xp,
money), restores the cursor, then calls the original — which
re-reads the same data without seeing our peek. Side-effect-free.
Does NOT fire on quest abandon, on QUEST_FINISHED window
transitions (which fire on Detail → Progress → Reward → Close —
not a clean turn-in signal), or on server-reject paths (bag-full,
quest invalidated, etc.). Only fires on a real successful turn-in.
Why not key off
QUEST_FINISHED? Native vanillaQUEST_FINISHEDfires on every quest-window state transition, including reads, aborts, and player-side close. The SMSG_QUESTGIVER_QUEST_COMPLETE packet, by contrast, is server-authoritative — the server only sends it after committing the turn-in (XP / money / item awards done, quest removed from log). Hooking the packet handler gives us the same signal modern WoW's event uses.
UPDATE_SHAPESHIFT_FORM event
Fires whenever the local player's shapeshift form changes — entering
or leaving cat / bear / travel / stance / shadowform / stealth /
ghost wolf / etc. No payload; call
GetShapeshiftFormID() from the handler to
read the new form.
Polyfills the modern singular event. Vanilla 1.12 has only the plural
UPDATE_SHAPESHIFT_FORMS (fires when the list of available forms
changes — learning a new form, not changing into one). The singular
"current form changed" event was added in a later expansion.
local f = CreateFrame("Frame")
f:RegisterEvent("UPDATE_SHAPESHIFT_FORM")
f:SetScript("OnEvent", function()
if event == "UPDATE_SHAPESHIFT_FORM" then
print("now in form", GetShapeshiftFormID())
end
end)
Implementation notes
Hooks the engine's bonus-action-bar refresh helper at 0x004E4FC0,
which the engine calls every time the local player's UNIT_BYTES_1
descriptor field is broadcast and from FUN_004908C0 at post-login
init. After the original runs, the post-hook reads byte 2 of
UNIT_BYTES_1 (descriptor +0x212 — the form ID) and fires
UPDATE_SHAPESHIFT_FORM only when the value differs from the last
seen — filtering out the spurious recomputes for other UNIT_BYTES_1
bytes (standstate, etc.) the engine also routes through this helper.
The cached "last form" sentinel uses -1 for "player descriptor not
yet resolvable" so transient resolution failures during early login
don't get misread as leaving a form.
Expansion
Helpers shipped by modern Classic Era / Cata Classic for addons that
want to gate code on which expansion the client targets. We always
answer as LE_EXPANSION_CLASSIC (0) — the DLL is built against
1.12 offsets, so there's nothing to detect. The matching number
constants (LE_EXPANSION_*) are in the Globals section.
GetClassicExpansionLevel()
Returns the live expansion level as a number. Always 0
(LE_EXPANSION_CLASSIC) here.
if GetClassicExpansionLevel() >= LE_EXPANSION_BURNING_CRUSADE then
-- never taken on 1.12
end
ClassicExpansionAtLeast(expansionLevel)
Returns true iff GetClassicExpansionLevel() >= expansionLevel.
On 1.12 that reduces to expansionLevel <= 0, so only
ClassicExpansionAtLeast(LE_EXPANSION_CLASSIC) (and any negative
argument) are true; every later expansion answers false.
Errors if expansionLevel is missing or non-numeric — matches the
modern signature.
if ClassicExpansionAtLeast(LE_EXPANSION_WRATH_OF_THE_LICH_KING) then
-- WotLK+ code path; never taken on 1.12
end
ClassicExpansionAtMost(expansionLevel)
Returns true iff GetClassicExpansionLevel() <= expansionLevel.
On 1.12 that reduces to expansionLevel >= 0, so the only false
answer is for negative input.
Errors if expansionLevel is missing or non-numeric.
if ClassicExpansionAtMost(LE_EXPANSION_CLASSIC) then
-- vanilla / Classic Era only code path
end
Faction
GetFactionIDByIndex(factionIndex)
Returns the factionID (Faction.dbc row ID) for the entry at the given 1-based
displayed-faction index. Modern WoW (5.0+, including Classic Era 1.15.x)
returns this as the 14th value of GetFactionInfo; older clients (1.12
through 3.3.5) don't expose it from Lua at all, even though the engine
uses it internally to look up Faction.dbc.
- Returns the factionID for real factions.
- Returns
0for header / category rows ("Other","Inactive", etc.) — matching the modern Classic Era client, which puts0inGetFactionInfo'sfactionIDslot for those rows. - Returns
nilif the index is out of range.
The "headers normalize to 0" rule deliberately matches modern WoW
(5.0+) behavior. The 1.12 engine actually returns 0 for some header
types ("Other") and -1 for others ("Inactive"-style pseudo-rows);
we collapse both to 0 so the user-facing convention is consistent.
for i = 1, GetNumFactions() do
local name, _, _, _, _, _, _, _, isHeader = GetFactionInfo(i)
if not isHeader then
local factionID = GetFactionIDByIndex(i)
-- ...
end
end
GetFactionInfoByID(factionID)
Returns the same eleven values as GetFactionInfo(factionIndex), keyed by
factionID instead of displayed index:
name, description, standingID, barMin, barMax, barValue,
atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep
Works for any factionID present in Faction.dbc, not just factions the
player has rep with:
- In the player's reputation list — full data, identical to
GetFactionInfo(displayedIndex). - Not in the reputation list — name and description from
Faction.dbc, Neutral defaults for the rep fields:standingID = 4,barMin = 0,barMax = 3000,barValue = 0, all flagsnil. Matches what 3.3.5'sGetFactionInfoByIDreturns for unencountered factions. - Invalid factionID (out of range or empty DBC slot) —
nil.
local name, _, standing = GetFactionInfoByID(69) -- Darnassus
-- name = "Darnassus", standing = 5 (Friendly), etc. (encountered)
local name = GetFactionInfoByID(574) -- Caer Darrow (faction that can't be encountered in standard Vanilla)
-- name = "Caer Darrow" — works even if you never had rep with it
GetFactionParentID(factionID)
Returns the parent factionID for a faction in a hierarchy (e.g.
Stormwind's parent is Alliance Forces; The Defilers's parent is
Horde Forces). Returns 0 for top-level factions with no parent,
or nil for invalid factionIDs.
GetFactionParentID(72) -- 469 (Stormwind → Alliance)
GetFactionParentID(469) -- 0 (Alliance is top-level)
GetFactionParentID(99999) -- nil
Modern WoW returns this as the 13th value of GetFactionInfoByID;
we expose it as its own getter since 1.12's GetFactionInfo doesn't
have the slot.
Reads Faction.dbc ParentFactionID at record +0x48 directly —
no displayed-list dependency, works for any faction in the DBC
regardless of whether the player has rep with it.
C_Reputation.GetFactionStandings()
Returns a flat { [factionID] = currentStanding } table covering
every faction in the player's reputation list. currentStanding is
the same value GetFactionInfo puts in its barValue slot — `base
- delta` from the rep slot, signed.
Always returns a table (possibly empty); never nil.
local standings = C_Reputation.GetFactionStandings()
for factionID, standing in pairs(standings) do
print(GetFactionInfoByID(factionID), standing)
end
Unlike a GetNumFactions + GetFactionInfo walk, this skips header
rows entirely and doesn't depend on the player having opened the
reputation pane recently — it reads straight out of the per-faction
rep-slot array, which the engine keeps populated for every faction
the player has rep with.
If you need names instead of IDs, layer GetFactionInfoByID on top:
local byName = {}
for factionID, standing in pairs(C_Reputation.GetFactionStandings()) do
byName[GetFactionInfoByID(factionID)] = standing
end
This is a ClassicAPI-only call; modern WoW's closest equivalent is
the 11.x C_Reputation.GetFactions(), which returns an array of
struct tables rather than a flat map.
C_Reputation.GetWatchedFactionData()
Returns a table describing the faction shown above the XP bar, or
nil if no faction is being watched. Backports the modern
struct-style accessor — vanilla's GetWatchedFactionInfo() returns
the same data as a 5-tuple without the factionID, which is the field
modern callers rely on most.
Returns the same FactionData table shape as
GetFactionDataByIndex
— see that section for the full field list. isWatched is forced
true (this faction IS the watched one by definition).
local data = C_Reputation.GetWatchedFactionData()
if data then
print(string.format("%s (%d): %d / %d",
data.name, data.factionID,
data.currentStanding - data.currentReactionThreshold,
data.nextReactionThreshold - data.currentReactionThreshold))
end
Implementation reads the watched RepListID from the player's
+0xE68 sub-struct, indexes the per-faction rep slot array at
0x00B73290 to recover the factionID, then runs the shared
ReadFactionData chain (Faction.dbc lookup, reaction band, rep slot
flags, header/collapsed checks).
C_Reputation.GetFactionDataByIndex(factionSortIndex)
Returns a FactionData table for the faction at the given 1-based
displayed-list index, or nil for an out-of-range index or a
pseudo-row ("Other" / "Inactive" placeholders that don't have a
Faction.dbc record). The index range matches what GetNumFactions
covers — real factions plus category headers.
Fields:
| Field | Type | Notes |
|---|---|---|
factionID |
number | Faction.dbc record ID. |
name |
string | Locale-applied. |
description |
string | Locale-applied (may be ""). |
reaction |
number | 1=Hated .. 8=Exalted. |
currentReactionThreshold |
number | Band min standing value. |
nextReactionThreshold |
number | Band max standing value. |
currentStanding |
number | Current standing (base + delta). |
atWarWith |
boolean | Rep slot flags bit 0x02. |
canToggleAtWar |
boolean | currentStanding ≥ -3000 AND not peace-forced (flags bit 0x10). |
isHeader |
boolean | Faction is a category header in the displayed list. |
isHeaderWithRep |
boolean | Always false in vanilla — parent factions don't aggregate rep. |
isCollapsed |
boolean | UI state: user has collapsed this header. |
isWatched |
boolean | This faction is shown above the XP bar. |
canSetInactive |
boolean | True when !isHeader && repListIndex ≥ 0 — i.e. the engine's SetFactionInactive/SetFactionActive will accept this faction. |
isChild |
boolean | Always false (parent-child rep introduced post-vanilla). |
hasBonusRepGain |
boolean | Always false (added in MoP). |
isAccountWide |
boolean | Always false (added in Dragonflight). |
for i = 1, GetNumFactions() do
local d = C_Reputation.GetFactionDataByIndex(i)
if d and not d.isHeader and d.currentStanding < d.nextReactionThreshold then
-- still grindable rep
end
end
Implementation: resolves the 0-based index to a factionID via the
engine's FUN_RESOLVE_FACTION_INDEX at 0x004D5FA0, then runs the
shared ReadFactionData chain — no Lua-side round-trip through
Script_GetFactionInfo. isHeader / isCollapsed come from the
displayed-list header array at 0x00B736C0 (count at 0x00B736B0)
and the per-character bitmask at 0x0084A0A4.
C_Reputation.SetWatchedFactionByID(factionID)
Sets the faction shown above the XP bar by ID. The vanilla
SetWatchedFactionIndex(displayedIndex) accepts only a 1-based
displayed-list index, which forces addons to walk the index list
themselves. This wrapper takes a factionID directly.
factionID > 0— sets the watched faction. Works even for factions the player hasn't yet encountered (the rep bar will show nothing until the player gains rep, then displays normally).factionID == 0— clears the watched faction.factionID < 0— silent no-op.
Returns nothing. The engine's UI / event machinery refreshes
automatically — GetWatchedFactionInfo() reflects the new state
on the next call.
C_Reputation.SetWatchedFactionByID(72) -- Stormwind
print(GetWatchedFactionInfo()) -- "Stormwind", ...
C_Reputation.SetWatchedFactionByID(0) -- clear
print(GetWatchedFactionInfo()) -- (empty)
Implementation calls the engine's inner watched-faction setter
directly, bypassing Script_SetWatchedFactionIndex's
displayed-index round-trip.
C_Reputation.GetLastStandingChange()
Returns factionID, newStanding, repGained for the rep change
currently being fired, or nil if called outside that window.
Companion to FACTION_STANDING_CHANGED.
The triple is the same payload as the event's arg1, arg2, arg3, but
the getter is also live during the engine's
CHAT_MSG_COMBAT_FACTION_CHANGE dispatch on the same hook — useful
for addons that want to enrich the chat line with the factionID
(which vanilla's chat-event payload doesn't carry) without
double-registering for FACTION_STANDING_CHANGED:
local f = CreateFrame("Frame")
f:RegisterEvent("CHAT_MSG_COMBAT_FACTION_CHANGE")
f:SetScript("OnEvent", function()
local factionID, newStanding, repGained = C_Reputation.GetLastStandingChange()
if factionID then
-- factionID is the real ID, not a parsed-out name string
print(factionID, newStanding, repGained)
end
end)
Outside the in-flight FireNotify hook stack (i.e. anywhere except
inside a CHAT_MSG_COMBAT_FACTION_CHANGE or FACTION_STANDING_CHANGED
handler), returns nothing. There is no "last change" memory — the
state is cleared as soon as the dispatch returns.
This is a ClassicAPI-only call; modern WoW has no equivalent (modern
addons get the factionID from FACTION_STANDING_CHANGED directly, so
they don't need a separate getter).
FriendList
C_FriendList.SendWhoQueryByName(name)
Issues a /who name-filter query for a specific player. Results
buffer into the engine's WhoList so a normal WHO_LIST_UPDATE +
GetWhoInfo(i) flow can read them — no chat output, no
"Found N players matching..." system message.
Vanilla 1.12 exposes SendWho(query) and SetWhoToUI(flag) only as
separate primitives, so addons that want to silently look up a
single player's class/level/zone (e.g. to color an unknown name in
chat) have to manage state, cooldown timing, and friends-panel
suppression themselves. This collapses the invocation half of that
dance to one call with a clean true/false return.
Returns true if the query was sent, false if any of:
- the name was empty / nil
- the call is within the 5-second cooldown of a previous send
- the engine's WhoSystem isn't initialized yet (pre-login)
A false return is a no-op — the engine state isn't touched, no
pending flag is set, and the cooldown isn't extended. Safe to call
on every chat line that mentions an unknown player; the call will
naturally rate-limit.
The cooldown matches the server's: vanilla's CMSG_WHO is silent- dropped server-side at roughly 5-second granularity, so a faster client just wastes queries that won't get a response.
if C_FriendList.SendWhoQueryByName("Bob") then
-- query sent; result will arrive via WHO_LIST_UPDATE within ~1s
end
This call alone does not suppress the friends-panel popup on
response — for that, wrap FriendsFrame_OnEvent and gate on
C_FriendList.IsWhoQueryPending():
local original = FriendsFrame_OnEvent
_G.FriendsFrame_OnEvent = function()
if event == "WHO_LIST_UPDATE" and C_FriendList.IsWhoQueryPending() then
return
end
return original()
end
(Auto-suppressing the popup from C++ would require hooking the
engine's FrameScript_SignalEvent or the SMSG_WHO opcode handler —
both high-traffic / high-risk sites. The wrap above is reliable and
takes 5 lines, so it stays addon-side for now.)
Implementation reads the WhoSystem singleton from 0x00C28168 and
calls the inner sender at 0x005AEBB0
(__thiscall(this = WhoSystem, queryStr)), the same chokepoint
Script_SendWho tail-calls. The whoToUI flag at 0x00C2A12C is
flipped to 1 first so the SMSG_WHO handler routes results into the
list (WHO_LIST_UPDATE path) instead of printing to chat.
C_FriendList.IsWhoQueryPending()
Returns true within ~5 seconds of the most recent
SendWhoQueryByName that
returned true; otherwise false. Time-based — the engine doesn't
expose a "response arrived" hook to C++ yet, so the window is a
conservative upper bound on the response RTT, which in practice
lands within a few hundred ms.
The intended use is gating an addon-side FriendsFrame_OnEvent
wrap so the user-issued /who window still works while addon-
issued silent queries don't pop the panel — see the example under
SendWhoQueryByName.
Concurrent callers see a shared pending flag — if pfUI and another
addon both call SendWhoQueryByName close in time, both queries
contribute to the same pending window. This is acceptable for the
"suppress popup for any in-flight DLL-issued query" use case;
addons that need per-call tracking should manage their own ticket
state on top.
GameTooltip
GameTooltip:SetItemByID(itemID)
Modern method that renders an item tooltip from just an itemID. The
1.12 workaround was constructing an item hyperlink and calling
SetHyperlink — tooltip:SetHyperlink("item:" .. id .. ":0:0:0:0:0:0:0")
— which works but forces every caller to know the hyperlink format.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetItemByID(6948) -- Hearthstone
GameTooltip:Show()
Implementation: snprintf the hyperlink string and dispatch to the
existing Script_GameTooltip_SetHyperlink (registry slot 12).
Item cache caveat. 1.12 lazy-loads item data into the client-side cache at
0x00C0E2A0— the cache is fed bySMSG_ITEM_QUERY_SINGLE_RESPONSEonly when the player encounters an item. For an itemID the player has never seen, the tooltip renders only the name; full data appears once the cache is warm.The fix is to ensure the item is cached before opening the tooltip:
if C_Item.IsItemDataCachedByID(itemID) then GameTooltip:SetItemByID(itemID) else C_Item.RequestLoadItemDataByID(itemID) -- register for ITEM_DATA_LOAD_RESULT(loadedItemID, success) -- and call SetItemByID once the matching itemID arrives endThis caching behavior matches what
C_Item.GetItemInfoInstantdocuments — same underlying cache. Modern WoW (5.0+) has the same caveat, just withC_Item.RequestLoadItemData(itemLocation)/Item:OnItemLoad-style continuation.
GameTooltip:SetUnitAura(unit, index, [filter])
Modern unified-aura method. 1.12 splits this into SetUnitBuff and
SetUnitDebuff; we dispatch to the right one based on the filter
string ("HARMFUL" → SetUnitDebuff, anything else → SetUnitBuff).
filter defaults to helpful when omitted, matching modern.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetUnitAura("player", 1, "HELPFUL") -- first buff
GameTooltip:SetUnitAura("player", 1, "HARMFUL") -- first debuff
GameTooltip:SetUnitAura("player", 1) -- defaults to HELPFUL
GameTooltip:Show()
Pure dispatcher — no engine changes; the underlying logic is whatever
1.12's SetUnitBuff / SetUnitDebuff already does. Just lets you use
the modern call shape (which most aura libraries backport from)
without conditionally splitting on filter.
GameTooltip:SetSpellByID(spellID)
Renders a spell tooltip for any spellID, including spells the player has
not learned. The stock 1.12 GameTooltip:SetSpell(slot, bookType) only works
for entries in the player's spellbook (or pet book). SetSpellByID bypasses
the spellbook indirection and calls WoW's internal tooltip builder directly.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetSpellByID(133) -- Fireball
GameTooltip:Show()
GameTooltip:GetItem()
Returns (name, link, itemID) for whichever item the tooltip is
currently displaying, or nothing if it isn't showing an item. Modern
WoW returns only (name, link); we extend with itemID as a third
return so callers don't have to gsub-extract it from the link.
The engine stashes two fields per Set* item call:
tooltip+0x398← itemID (always populated)tooltip+0x380/+0x384← item GUID (only when there's a real CGItem —SetBagItem,SetInventoryItem,SetLootItem,SetMerchantItem, etc. Zero forSetItemByID/SetHyperlinkwhich have no instance.)
Both fields are zeroed by the per-tooltip Clear on Hide / before the next Set*.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
-- SetItemByID — no per-instance data, basic link returned
GameTooltip:SetItemByID(6948)
local name, link, id = GameTooltip:GetItem()
-- name = "Hearthstone"
-- link = "|cffffffff|Hitem:6948:0:0:0:0:0:0:0|h[Hearthstone]|h|r"
-- id = 6948
-- SetInventoryItem — full dressed link with enchant + random suffix
GameTooltip:SetInventoryItem("player", INVSLOT_BACK)
local name, link, id = GameTooltip:GetItem()
-- name = "Superior Cloak"
-- link = "|cff1eff00|Hitem:9805:247:843:0|h[Superior Cloak of the Eagle]|h|r"
-- id = 9805
Two link paths:
| Set* path | Link form | Dressing |
|---|---|---|
SetBagItem, SetInventoryItem, SetLootItem, SetMerchantItem, … |
Full dressed link via the engine's own builder at 0x0052AE00 |
Enchant ID, random-suffix factor, unique ID, suffix-decorated name |
SetItemByID, SetHyperlink (item:N with no instance data) |
Basic colored link | itemID + cached quality + cached name only |
The dressed-link path works for items not in player inventory (merchant, loot, mailbox, trade window, etc.) — the engine's resolver finds any CGItem the client has loaded.
Returns nothing for: non-item tooltip, uncached itemID on the no-GUID path (fires a background cache warmup), or empty name.
GameTooltip:GetSpell()
Returns (name, rank, spellID) for whichever spell the tooltip is
currently displaying, or nothing if it isn't showing a spell. The
engine stashes the spellID on the tooltip frame at +0x39C whenever
any SetX spell path runs (SetSpell, SetSpellByID,
SetUnitBuff/SetUnitDebuff, SetTalent, etc.) and zeroes it on
the next Clear / Hide.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetSpellByID(25306)
local name, rank, spellID = GameTooltip:GetSpell()
-- name = "Fireball"
-- rank = "Rank 12"
-- spellID = 25306
rank is the empty string (not nil) for spells whose Spell.dbc rank
slot is blank — most racials, talent passives, and proc-triggered
spells. This matches the modern semantics where the rank position is
always populated.
GameTooltip:HasItem() / GameTooltip:HasSpell()
Boolean companions to GetItem / GetSpell. Return true if the
tooltip is currently displaying an item / spell, false otherwise.
Cheaper than GetItem / GetSpell when all you need is the
predicate — single uint32 read against OFF_TOOLTIP_ITEM_ID /
OFF_TOOLTIP_SPELL_ID, no DBC lookup or link-build.
if GameTooltip:HasItem() then
local _, link = GameTooltip:GetItem()
-- only do the GetItem work when we actually need it
end
GameTooltip:GetUnitGUID() / GameTooltip:HasUnit()
GetUnitGUID() returns (name, guidString) for whichever unit the
tooltip is currently displaying, or nothing if it isn't showing a
unit. Return order mirrors modern's GameTooltip:GetUnit() (name
first) — so addons porting from
local name, unit = ttip:GetUnit() can swap to GetUnitGUID and
keep their existing destructuring. name is the unit's display name
— the same string that appears in the tooltip header, or one of the
engine's "UNKNOWNOBJECT" / "Unknown Being" fallbacks for a remote
unit whose info hasn't been queried yet. guidString is the
canonical "0xHHHHHHHHLLLLLLLL" format returned by
UnitGUID(unit).
HasUnit() is a boolean companion — returns true if the tooltip is
currently displaying a unit.
GameTooltip:SetUnit("target")
local name, guid = GameTooltip:GetUnitGUID()
-- name = "Hogger"
-- guid = "0xF130001234..." (Creature) or "0x000000...ABC123" (Player)
if GameTooltip:HasUnit() then
-- cheap predicate, no name-resolution work
end
Why not match modern's
GetUnit()signature? Modern WoW'sGetUnit()returns(name, unitToken)whereunitTokenis the exact"target"/"focus"/"mouseover"/ etc. string passed toSetUnit. Vanilla 1.12 drops the token at theScript_GameTooltip_SetUnitboundary — it converts the token to a 64-bit GUID and discards the original string. Reconstructing a plausible token by walking known tokens and reverse-matching by GUID is possible but lossy (multiple tokens can refer to the same GUID —"target"and"raid1"simultaneously, for instance), so we expose the GUID directly instead, which is what addons actually need for cross-referencing withUnitGUID, the NameCache, etc.
GameTooltip:GetGameObject() / GameTooltip:HasGameObject()
GetGameObject() returns (name, id, guid) for whichever gameobject
the tooltip is currently displaying, or nothing if it isn't showing
one. name is the cached display name (or "" until the gameobject
cache has loaded the record). id is the gameobject's template /
entry — same key gameobjectcache.wdb uses, and what the server
sent in the spawn packet. guid is the canonical
"0xHHHHHHHHLLLLLLLL" format.
HasGameObject() is the boolean companion — returns true if the
tooltip is currently displaying a gameobject (single uint32 read,
no resolution work).
-- Mouse over a chest, vein, signpost, etc. then:
local name, id, guid = GameTooltip:GetGameObject()
-- name = "Iron Deposit"
-- id = 1731
-- guid = "0xF110000006C30000..."
if GameTooltip:HasGameObject() then
-- cheap predicate
end
There is no Lua-callable SetGameObject method in vanilla 1.12
— gameobjects only populate the tooltip via in-world mouseover. The
engine's hover handler at FUN_00492890 dispatches to a tooltip
populator (0x0052AA20) that writes the GUID into
tooltip+0x370/+0x374, right between the unit slot (+0x368) and
the item slot (+0x380). The shared tooltip-clear zeroes the same
slot on every subsequent SetX, so these methods follow the same
gating pattern as HasUnit / HasSpell / HasItem.
Returns nothing for: tooltip not showing a gameobject, or the
gameobject has left the engine's visibility window (object manager
evicted it). HasGameObject() stays true in the latter case —
the tooltip-frame slot still has the GUID, even though the live
object has been freed.
GameTooltip:GetOwner()
Returns the frame that called tooltip:SetOwner(frame, anchor), or
nil if the tooltip hasn't been owned by anyone since its last
Clear / Hide. Vanilla 1.12 ships SetOwner and IsOwned but
never added the matching reader; modern Classic Era's signature is
backported here for parity.
GameTooltip:SetOwner(SomeFrame, "ANCHOR_TOPLEFT")
local owner = GameTooltip:GetOwner()
-- owner == SomeFrame
Returns only the owner frame, not (owner, anchorPoint) like modern
Classic. The anchor string is reachable via vanilla's native
GameTooltip:GetAnchorType()
(slot 5 in the GameTooltip method registry).
GameTooltip:SetTalentByID(talentID)
Renders a tooltip for the talent identified by Talent.dbc primary
key — the natural pair to
GetTalentIDByIndex.
Works for any class's talents, not just the player's.
Two-tier resolution:
| Tier | When it applies | Tooltip rendered |
|---|---|---|
| Player class (rich) | talentID belongs to one of the player's loaded tabs |
Full talent tooltip — name, "Rank N/M", description, prereqs, "click to learn" prompts |
| Cross-class (fallback) | talentID is from another class |
Spell tooltip for the talent's rank-1 spellID — name, cast time, range, mana cost, description |
The fallback exists because vanilla 1.12 only loads the local
player's class talent data into the engine's per-player TabInfo
arrays. For other classes, we look up the talent in Talent.dbc
directly and dispatch the rank-1 spell tooltip — functionally
"what does this talent do?" without the rank counter. Modern WoW
adds talent name and "Rank 0/N" decorations on top of the spell
description for cross-class; we don't replicate that here yet.
Silent no-op (no tooltip change) when:
talentIDdoesn't match any record inTalent.dbctalentIDisnil, non-numeric, or non-positive
-- Player's own class — rich tooltip
local talentID = GetTalentIDByIndex(1, 9) -- player's tab 1, talent 9
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetTalentByID(talentID)
GameTooltip:Show()
-- Other class — spell tooltip for the talent's primary ability
GameTooltip:SetTalentByID(2065) -- works regardless of player class
GameTooltip:Show()
GameTooltip:SetInventoryItemByID(itemID)
Renders the tooltip for the equipped instance of itemID —
walks character-pane slots 1..19, finds the matching item, and
shows it with its actual enchants, random-suffix stats, and
broken/locked state. Distinct from
SetItemByID, which shows the
clean ItemSparse data with no instance-specific decorations.
For example, on a pair of boots with a run-speed enchant equipped:
| Method | Renders |
|---|---|
SetItemByID(<bootsID>) |
Base boots tooltip — name, armor, durability, level req. No enchant. |
SetInventoryItemByID(<bootsID>) |
Same plus Enchanted: Minor Speed and any random-suffix lines. |
Silent no-op if the item isn't currently equipped — fall back to
SetItemByID for unworn items, or check via
C_Item.IsEquippedItem first.
When the player has duplicates of the same itemID equipped (matched MH/OH weapons, identical rings, identical trinkets), the lower-numbered slot wins — MAINHAND before OFFHAND, FINGER1 before FINGER2, TRINKET1 before TRINKET2. Matches modern client behavior (verified empirically).
local _, _, _, _, _, _, _, _, _, _, _, _, _, link = GetItemInfo(itemID)
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
if C_Item.IsEquippedItem(itemID) then
GameTooltip:SetInventoryItemByID(itemID) -- shows enchants/suffix
else
GameTooltip:SetItemByID(itemID) -- shows base stats
end
GameTooltip:Show()
GameTooltip:SetEquipmentSet(name)
Fills the tooltip with a summary of the named equipment set: header,
total item count, and per-bucket counts (equipped / in inventory /
ignored / missing). Each missing item is listed on its own line by
name. Mirrors 4.3.4's native GameTooltip:SetEquipmentSet at
0x0046E690.
GameTooltip:SetOwner(UIParent, "ANCHOR_CURSOR")
GameTooltip:SetEquipmentSet("MyTank")
GameTooltip:Show()
MyTank (header, white)
14 items
12 equipped (green)
1 in inventory
1 slots ignored (gray)
Missing: Crown of the Endless Conqueror (red)
Silent no-op if no set with that name exists. The owner anchor must
be set before the call — SetEquipmentSet only fills the lines, it
doesn't re-anchor the tooltip frame.
Item classification reuses Locations::FindGUID (the same walk
GetItemCount uses), so items in the bank count as "in inventory"
without requiring the bank window to be open. The 4.3.4 binary did
the same.
Localization. The count lines are formatted through
Game::Lua::PushLocalizedFormatInt — Blizzard's ITEMS_VARIABLE_QUANTITY,
ITEMS_EQUIPPED, ITEMS_IN_INVENTORY, ITEM_SLOTS_IGNORED, and
ITEM_MISSING FrameXML globals are tried first, with English C-string
fallbacks for servers stripped of standard GlobalStrings. The
companion !!!ClassicAPI addon ships English defaults for these keys
so the tooltip works on bare-bones builds where FrameXML hasn't
populated them.
Missing-item names. The on-disk equipment-set format
(WTF\Account\<acct>\<realm>\<char>\ClassicAPI_EquipmentSets.txt)
persists each slot as both a 64-bit GUID and the itemID at save
time:
set 1
name=MyTank
icon=INV_Helmet_03
slot 1 guid=0xC00000000A1B2C3D item=51220
slot 5 ignored
The GUID is the live handle for items currently in inventory; the
itemID is the type identifier used when the live CGItem isn't
findable (item sold, mailed, on another character, etc.) — without
it we couldn't recover the name for missing items. Sets saved
before the itemID field was added load fine but render their
missing slots with the count summary %d missing instead of named
lines; re-saving a set repopulates itemIDs.
Globals
CLASSIC_API_VERSION
Defined once FrameScript has booted. Addons can use this to detect that
the DLL is loaded and which version is in use. The value is
X*10000 + Y*100 + Z for a tag of vX.Y.Z passed to CMake at configure
time via -DCLASSICAPI_TAG=vX.Y.Z. Unset versions resolve to 0.
if CLASSIC_API_VERSION and CLASSIC_API_VERSION >= 10200 then
-- ClassicAPI v1.2.0 or newer is loaded
end
LE_EXPANSION_*
The retail / Classic Era expansion-level enum, exposed as Lua globals
so addons backporting from later expansions don't have to gate on
if LE_EXPANSION_CLASSIC then (the constant being defined is itself
the version probe). Values match the modern Enum.ExpansionLevel
table. The matching helper functions
(GetClassicExpansionLevel / ClassicExpansionAtLeast /
ClassicExpansionAtMost) live in the Expansion section.
| Constant | Value |
|---|---|
LE_EXPANSION_LEVEL_CURRENT |
0 (this is Classic) |
LE_EXPANSION_CLASSIC |
0 |
LE_EXPANSION_BURNING_CRUSADE |
1 |
LE_EXPANSION_WRATH_OF_THE_LICH_KING |
2 |
LE_EXPANSION_CATACLYSM |
3 |
LE_EXPANSION_MISTS_OF_PANDARIA |
4 |
LE_EXPANSION_WARLORDS_OF_DRAENOR |
5 |
LE_EXPANSION_LEGION |
6 |
LE_EXPANSION_BATTLE_FOR_AZEROTH |
7 |
LE_EXPANSION_SHADOWLANDS |
8 |
LE_EXPANSION_DRAGONFLIGHT |
9 |
LE_EXPANSION_WAR_WITHIN |
10 |
LE_EXPANSION_MIDNIGHT |
11 |
-- Classic version check using modern idiom
if LE_EXPANSION_LEVEL_CURRENT < LE_EXPANSION_BURNING_CRUSADE then
-- pure-1.x (vanilla / Classic Era) code path
end
-- Probe for ClassicAPI presence
if LE_EXPANSION_LEVEL_CURRENT then
-- the constants are defined → ClassicAPI is loaded
end
LE_ITEM_QUALITY_*
The item-quality enum (modern Enum.ItemQuality), exposed as Lua
globals so addons backporting modern code can do
if quality >= LE_ITEM_QUALITY_RARE then ... against the integer
quality returned by GetItemInfo / C_Item.GetItemInfoInstant.
| Constant | Value | Color in tooltip |
|---|---|---|
LE_ITEM_QUALITY_POOR |
0 |
gray (junk) |
LE_ITEM_QUALITY_COMMON |
1 |
white |
LE_ITEM_QUALITY_UNCOMMON |
2 |
green |
LE_ITEM_QUALITY_RARE |
3 |
blue |
LE_ITEM_QUALITY_EPIC |
4 |
purple |
LE_ITEM_QUALITY_LEGENDARY |
5 |
orange |
LE_ITEM_QUALITY_ARTIFACT |
6 |
gold (TBC+ only) |
LE_ITEM_QUALITY_HEIRLOOM |
7 |
light blue (WotLK+ only) |
LE_ITEM_QUALITY_WOWTOKEN |
8 |
orange (WoD+ only) |
Values 0..5 (POOR..LEGENDARY) correspond to actual qualities present
in vanilla 1.12. Higher values are exposed for source compatibility
with modern addons — vanilla items will never carry those quality
values, so a comparison like quality == LE_ITEM_QUALITY_HEIRLOOM
trivially never matches and the rest of the code path is unreachable.
local _, _, quality = GetItemInfo(itemID)
if quality and quality >= LE_ITEM_QUALITY_RARE then
-- highlight in UI
end
LE_UNIT_STAT_*
The primary-stat enum (modern Enum.UnitStat), exposed as Lua globals
so addons can index UnitStat(unit, statIndex) symbolically:
| Constant | Value | Stat |
|---|---|---|
LE_UNIT_STAT_STRENGTH |
1 |
Strength |
LE_UNIT_STAT_AGILITY |
2 |
Agility |
LE_UNIT_STAT_STAMINA |
3 |
Stamina |
LE_UNIT_STAT_INTELLECT |
4 |
Intellect |
LE_UNIT_STAT_SPIRIT |
5 |
Spirit |
Values are stable across every WoW expansion — UnitStat("player", 1)
has always returned strength.
local _, effective = UnitStat("player", LE_UNIT_STAT_AGILITY)
Enum.AddOnSecurityStatus
The integer enum C_AddOns.GetAddOnSecurity returns. Matches
Blizzard's Enum.AddOnSecurityStatus:
| Value | Field | Notes |
|---|---|---|
0 |
Secure |
Blizzard-signed addons. |
1 |
Insecure |
User addons; default for any registered addon. |
2 |
Banned |
Server-disqualified entries. |
3 |
NotAvailable |
No addon by that name / index. |
if C_AddOns.GetAddOnSecurity(name) == Enum.AddOnSecurityStatus.Secure then
-- it's a Blizzard_* addon
end
Enum.PowerType
The integer enum UnitPowerType returns and UnitPower /
UnitPowerMax accept. Vanilla 1.12 only defines slots 0..4 — the
WotLK additions (Runes, Runic Power) and post-WotLK extensions
aren't included. Slot 4 is Happiness (vanilla pet happiness),
not modern's ComboPoints reuse of the same number.
| Value | Field | Notes |
|---|---|---|
-2 |
HealthCost |
Sentinel for "use HEALTH instead of POWER". |
-1 |
None |
Sentinel for "unit's primary power" (= omit the arg). |
0 |
Mana |
|
1 |
Rage |
|
2 |
Focus |
|
3 |
Energy |
|
4 |
Happiness |
Pet happiness — vanilla-specific. |
local rage = UnitPower("player", Enum.PowerType.Rage)
Gossip
Retail-shaped wrappers around vanilla's flat GetGossipText /
GetGossipOptions / GetGossipAvailableQuests / GetGossipActiveQuests
/ SelectGossipOption / SelectGossipAvailableQuest /
SelectGossipActiveQuest / CloseGossip surface. The data is the
same — these calls just read the engine's two gossip-state arrays
(0x00BBBE90 for options, 0x00BB74C0 for quests, both filled by the
SMSG_GOSSIP_MESSAGE handler at 0x004E26E0) and shape it into the
modern struct-tables that addons ported from retail expect.
Fields the 1.12 server simply doesn't send — and therefore aren't
in any of the returned tables — include rewards and spellID (added
after the post-vanilla quest/spell system rework), per-option
status (Available / Unavailable / Locked / AlreadyComplete — vanilla
servers don't compute this), and modern UX hints like overrideIconID
and selectOptionWhenOnlyOption.
The icon field is the raw icon-type byte from SMSG_GOSSIP_MESSAGE
(server-extensible — pservers can add custom NPC types past the
Blizzard 0..10 range). Default Blizzard types resolve to
Interface\GossipFrame\<Type>GossipIcon:
| Value | Type | Value | Type |
|---|---|---|---|
0 |
Gossip | 6 |
Banker |
1 |
Vendor | 7 |
Petition |
2 |
Taxi | 8 |
Tabard |
3 |
Trainer | 9 |
BattleMaster |
4 |
Healer | 10 |
Auctioneer |
5 |
Binder (innkeeper) |
C_GossipInfo.GetText()
Returns the gossip greeting string the engine resolved from the NPC's
referenced NPC_TEXT.dbc row. Same value GetGossipText() returns;
provided so addons that prefer the C_GossipInfo namespace don't have
to mix the two surfaces.
print(C_GossipInfo.GetText())
C_GossipInfo.GetOptions()
Returns an array of gossip-option tables in display order. Each entry contains:
| Field | Type | Notes |
|---|---|---|
gossipOptionID |
number | Vanilla optionIndex. The same value C_GossipInfo.SelectOption expects; arbitrary integer assigned by the server. |
name |
string | Option text (locale-applied by the server). |
icon |
number | Raw icon-type byte from SMSG_GOSSIP_MESSAGE — passed through unmapped so pserver-added types (anything past the default 0..10 range) survive. See the type table above for the default Blizzard categories and the Interface\GossipFrame\<Type>GossipIcon path each one resolves to. |
flags |
number | Bit 0 set = boxCoded (the option asks for confirmation text — Are you sure? boxes). |
orderIndex |
number | 1-based position in the emitted list. Matches the index SelectGossipOption (legacy) expects. |
for _, opt in ipairs(C_GossipInfo.GetOptions()) do
print(opt.gossipOptionID, opt.name, "icon", opt.icon)
end
C_GossipInfo.GetAvailableQuests()
Returns an array of deliverable-quest tables (quests the giver is
offering to start), in display order. Filter mirrors vanilla's
GetGossipAvailableQuests — status field at +0x008 not in {3, 4}.
| Field | Type | Notes |
|---|---|---|
questID |
number | Quest.dbc row ID. |
title |
string | Localized quest title. |
questLevel |
number | Quest level. |
C_GossipInfo.GetActiveQuests()
Returns an array of active-quest tables (quests the giver wants you
to turn in, in-progress or complete). Status field at +0x008 in
{3, 4}.
| Field | Type | Notes |
|---|---|---|
questID |
number | Quest.dbc row ID. |
title |
string | Localized quest title. |
questLevel |
number | Quest level. |
isComplete |
boolean | true when the engine's status byte is 4 (ready to turn in); false when it's 3 (still in progress). |
C_GossipInfo.GetNumOptions() / GetNumAvailableQuests() / GetNumActiveQuests()
Convenience counters — return the length of each of the three lists above without building the table.
C_GossipInfo.SelectOption(gossipOptionID) / SelectOptionByIndex(orderIndex)
Picks a gossip option. SelectOption resolves the modern
gossipOptionID to vanilla's 1-based slot, then tail-calls the
engine's native SelectGossipOption. SelectOptionByIndex is a thin
passthrough for callers that already have the slot index (e.g. from
opt.orderIndex on a GetOptions() entry, or from a UI button bound
directly to the slot).
Both end in the same CMSG; the option-ID variant exists so addons can
drive selections off the modern gossipOptionID key without keeping
their own slot mapping. Returns nothing.
Vanilla's SelectGossipOption doesn't accept a confirmation-text
argument, so for boxCoded options the engine's own confirm dialog
runs as usual — there is no way to send the password from the script.
C_GossipInfo.SelectAvailableQuest(questID)
Picks a deliverable quest by questID. Walks the active-vs-available
filter the same way GetAvailableQuests does, locates the matching
1-based slot, and tail-calls the engine's SelectGossipAvailableQuest.
Returns nothing.
C_GossipInfo.SelectActiveQuest(questID)
Picks an in-progress quest by questID. Same shape as
SelectAvailableQuest but walks the active filter and tail-calls
SelectGossipActiveQuest. Returns nothing.
C_GossipInfo.CloseGossip()
Closes the gossip window. Direct passthrough to the engine's
CloseGossip. Returns nothing.
Hooks
hooksecurefunc(name, callback) / hooksecurefunc(table, name, callback)
Modern post-call hook: the original function runs first, then
callback runs with the same args (return values discarded). The
original's return values propagate to the caller.
hooksecurefunc("GetSpellInfo", function(spellID)
print("GetSpellInfo called with " .. tostring(spellID))
end)
hooksecurefunc(GameTooltip, "SetInventoryItem", function(self, unit, slot)
-- runs after the engine fills the tooltip
print("inventory tooltip:", unit, slot)
end)
The "secure" label refers to taint-propagation behavior introduced in 2.0 for protected-frame manipulation. Vanilla 1.12 has no taint system, so the function is functionally equivalent to a plain "after-hook" — just preserves modern API parity for addons being backported from later expansions.
Implemented in pure C: builds a Lua C closure with (orig, callback)
as upvalues; the wrapper calls orig with LUA_MULTRET, then callback,
then returns orig's full result list. No return-count cap — works
correctly for functions returning any number of values.
Errors via lua_error on:
- Non-string
name - Non-function
callback target[name]not resolvable to a function (covers typos and hooking unknown frame methods)
Input
1.12 ships IsShiftKeyDown / IsControlKeyDown / IsAltKeyDown but
they only report "any shift/ctrl/alt" — there's no built-in way to tell
left from right. These seven functions add the missing distinction
plus an IsModifierKeyDown() rollup.
IsLeftShiftKeyDown() / IsRightShiftKeyDown()
IsLeftControlKeyDown() / IsRightControlKeyDown()
IsLeftAltKeyDown() / IsRightAltKeyDown()
Each returns 1 when the corresponding key is physically down, nil
otherwise — matching the convention 1.12's own IsShiftKeyDown etc.
use.
if IsLeftShiftKeyDown() and not IsRightShiftKeyDown() then
-- left-shift-only binding
end
IsModifierKeyDown()
Returns 1 if any of the six modifier keys is down, nil
otherwise. Equivalent to
IsShiftKeyDown() or IsControlKeyDown() or IsAltKeyDown() but in one
call.
Item
itemLocationargument shapesEvery
C_Item.*function on this page that takesitemLocationaccepts any of three forms, matching the modernItemLocationmixin plus a GUID-string convenience form:{ equipmentSlotIndex = N } -- 1-based, character pane { bagID = B, slotIndex = S } -- both required "0xHHHHHHHHLLLLLLLL" -- a GUID string from C_Item.GetItemGUIDTable forms are O(1) — the engine knows the slot. The GUID-string form is O(~80) — the function walks equipment slots 1..19 and bags 0..4 comparing each CGItem's stored GUID against the requested one. Bank and keyring are not walked. Fine for sporadic addon use; avoid for per-frame polling.
C_Item.IsBound(itemLocation)
Returns true if the item at the given location is soulbound, false otherwise
(including when the slot is empty or the location is malformed). The 1.12
client tracks the soulbound bit on each item instance directly; previously
the only way to read it from Lua was a scan-tooltip hack
(SetBagItem + string-compare against the localized ITEM_SOULBOUND
constant) — slow, locale-fragile, and one of the hottest paths during bag
updates.
if C_Item.IsBound({equipmentSlotIndex = INVSLOT_HEAD}) then ... end
if C_Item.IsBound({bagID = 0, slotIndex = 1}) then ... end
if C_Item.IsBound(itemGUID) then ... end
C_Item.GetItemID(itemLocation)
Returns the itemID of the item at the given location, or nil if the slot
is empty or the location is malformed. Useful as the input to
GetItemInfoInstant/GetItemInfo when you only know which slot an item
came from (rather than its link or ID).
Accepts the same itemLocation shapes as IsBound:
local id = C_Item.GetItemID({equipmentSlotIndex = INVSLOT_HEAD})
if id then
local _, type, subtype = C_Item.GetItemInfoInstant(id)
-- ...
end
GetInventoryItemID(unit, slot)
Returns the itemID of the item equipped at slot (1-based) on unit,
or nil if the slot is empty / the unit isn't valid / the unit doesn't
expose its equipment to the local client. Same arg shape as 1.12's
GetInventoryItemLink(unit, slot) — drop-in for code that just needs
the ID and would otherwise have to parse the link string.
- For
"player"(and any token resolving to the local player, e.g."target"when self-targeted): walks the private inventory manager. Supports the full slot range (equipment 1..19, bag slots 20..23, bank slots, etc.) — same rangeGetItemBySlotaccepts internally. - For other player-controlled units (
"target","party1"..party4", inspect targets): reads the unit's broadcast visible-items array. Equipment slots 1..19 only. - For NPCs / creatures: returns
nil. The visible-items array isn't populated for non-player-controlled units in 1.12, so we gate this onUnitPlayerControlledto avoid the engine crash thatGetInventoryItemLinkitself would trigger on the same input.
local id = GetInventoryItemID("player", INVSLOT_HEAD)
if id then
local _, type, subtype = C_Item.GetItemInfoInstant(id)
-- ...
end
-- Inspect a party member without parsing a hyperlink:
local headID = GetInventoryItemID("party1", INVSLOT_HEAD)
GetInventoryItemsForSlot(slot, returnTable [, transmogrify])
Populates returnTable with every item in the player's equipment
and bags that's eligible to be equipped in slot (1..19). Returned
table is keyed by the packed ItemLocation
bitfield — same encoding
C_EquipmentSet.GetItemLocations uses — with the itemLink as the
value. Returns the same returnTable reference for chaining.
local t = {}
GetInventoryItemsForSlot(16, t) -- mainhand
for loc, link in pairs(t) do
-- loc is a number like 0x00300103; link is "|c…|Hitem:…|h[…]|h|r"
end
| slot | Eligible InventoryTypes |
|---|---|
| 1 HEAD, 2 NECK, …, 10 HANDS | The slot's matching InventoryType |
| 11, 12 FINGER | INVTYPE_FINGER (11) — items appear under both ring slots |
| 13, 14 TRINKET | INVTYPE_TRINKET (12) |
| 15 BACK | INVTYPE_CLOAK (16) |
| 16 MAINHAND | INVTYPE_WEAPON (13), INVTYPE_2HWEAPON (17), INVTYPE_WEAPONMAINHAND (21) |
| 17 OFFHAND | INVTYPE_WEAPON (13), INVTYPE_SHIELD (14), INVTYPE_WEAPONOFFHAND (22), INVTYPE_HOLDABLE (23) |
| 18 RANGED | INVTYPE_RANGED (15), INVTYPE_THROWN (25), INVTYPE_RANGEDRIGHT (26) |
| 5 CHEST | INVTYPE_CHEST (5), INVTYPE_ROBE (20) |
| 19 TABARD | INVTYPE_TABARD (19) |
Compatibility check is a single bitwise AND against a static
invType → slotMask table — same shape and values as 3.3.5's table
at DAT_00A2D288 (used by Script_GetInventoryItemsForSlot via
FUN_007082B0), with two adjustments for vanilla:
- 2H weapons (
INVTYPE_2HWEAPON) confined to the mainhand slot only. 3.3.5 allowed offhand for the titanic-grip era; vanilla has no such mechanic and the server would reject the equip anyway. INVTYPE_WEAPONMAINHAND/WEAPONOFFHANDconfined to their literal slot rather than the looser "either hand" 3.3.5 allowed.
The transmogrify arg is accepted and ignored. Stock 1.12 has no
transmog system to query against, and the modern flag's effect
(broader cross-eligibility for visual swaps) reduces to the
regular equip check here. Private servers like Turtle WoW layer
their own transmog systems on top of vanilla; this function
doesn't currently plumb the flag through to any of them.
Bank items aren't included. Vanilla's
GetItemBySlotgates bank slots on a banker GUID that's only set while the bank window is open; modern WoW behaves the same way (bank shows up only when the bank UI is open). We don't walk bank slots — addons that want bank inclusion need their own bank scan with the bank UI open.
GetInventoryItemDurability(invSlot)
Returns (current, maximum) durability for the player's equipped item
at invSlot (1-based, character-pane slots 1..19), or nothing if the
slot is empty or the item has no durability concept (rings, trinkets,
necks, backs, shirts, tabards, etc.).
current, maximum = GetInventoryItemDurability(invSlot)
local cur, max = GetInventoryItemDurability(INVSLOT_CHEST)
if cur then
-- cur, max are positive integers (e.g. 65, 65 for full chest)
end
-- Items without durability return nothing — both locals are nil:
local cur, max = GetInventoryItemDurability(INVSLOT_FINGER1)
-- cur == nil, max == nil
Player-only. Matches modern API: 3.3.5+
GetInventoryItemDurabilitytakes only the slot, no unit token. Inspect targets / party members' equipment durability isn't broadcast in 1.12, so we couldn't expose it for other units even if we wanted to.
(0, max)vs nothing. Items that have a durability concept but are currently broken (current == 0,max > 0) still return(0, max). The "nothing" return is reserved for items that have no durability fields populated at all —maxis the discriminator, matching the engine's ownGetInventoryItemBrokenlogic.
Reads ITEM_FIELD_DURABILITY (+0xA0) and ITEM_FIELD_MAXDURABILITY
(+0xA4) directly off the CGItem's m_objectFields descriptor at +0x114
— same descriptor C_Item.IsBound reads
FLAGS from. No DBC indirection.
GetInventoryItemRepairCost(invSlot)
Returns the cost in copper to repair the player's equipped item at
invSlot. Same value GameTooltip:SetInventoryItem returns as its
third out-parameter.
copperCost = GetInventoryItemRepairCost(invSlot)
local cost = GetInventoryItemRepairCost(INVSLOT_CHEST)
if cost > 0 then
-- e.g. cost == 12345
end
Returns 0 for slots that are empty, items without a durability
concept, fully-repaired items, or items whose stats aren't cached yet
(rare — happens briefly after login before SMSG_ITEM_QUERY_RESPONSE
arrives for newly-seen items). The "no return" path is reserved for
invalid input (non-numeric slot).
Player-only, same constraint as
GetInventoryItemDurability— other units' durability isn't broadcast in 1.12.
Discount is vendor-context-dependent. The faction-rep + PvP rank discount is only applied when the player has a merchant window open (i.e. has received
SMSG_LIST_INVENTORY). Called from anywhere else, you get the raw, undiscounted base cost.The engine tracks the current merchant via globals
DAT_00BDDFA0/A4(the merchant's GUID), set when the merchant frame opens and zeroed when it closes. The helper short-circuits the discount path when those globals are zero.For consistent "what will I pay" semantics inside addons, only trust this value when
MerchantFrame:IsShown()is true — or call it once per merchant-visit and cache.
Calls the engine's own per-item repair-cost helper at 0x004FAF30,
which is the same function Script_GameTooltip_SetInventoryItem
calls for its repairCost return. The raw cost comes from
DurabilityCosts.dbc (indexed by item subclass and slot type) ×
DurabilityQuality.dbc (indexed by item quality); the discount —
when applicable — stacks faction reputation with the merchant
(Friendly+ unlocks a base 5%) and PvP rank (Sergeant Major+ adds
another 5%, Knight-Lieutenant+ stacks one more).
This is a ClassicAPI addition — modern WoW has no standalone Lua function for per-item repair cost; the only way to read it there is the tooltip's third return value. We expose it directly because the underlying calculation is already in the engine and a Lua function is the natural surface.
C_Item.GetItemFamily(item)
Returns the BagFamily bitmask for an item — i.e., what kind of
specialty bag it belongs in. 0 means "general-purpose" (no specialty
bag preference). Returns nil if the item isn't in the cache.
familyBitmask = C_Item.GetItemFamily(item)
item accepts a numeric itemID or a string containing "item:NNN"
(the bare shorthand and full chat links both parse correctly), same as
C_Item.GetItemInfoInstant.
C_Item.GetItemFamily(2512) -- 1 (Wooden Arrow → quiver-family)
C_Item.GetItemFamily(2516) -- 2 (Light Shot → ammo pouch-family)
C_Item.GetItemFamily(6265) -- 4 (Soul Shard → soul bag-family)
C_Item.GetItemFamily(2447) -- 32 (Peacebloom → herb bag-family)
C_Item.GetItemFamily(6948) -- 0 (Hearthstone → general-purpose)
Bitmask values match modern WoW's encoding (1 << (familyID - 1)):
| Bit | Value | Family |
|---|---|---|
| 0 | 1 | Quiver (arrows) |
| 1 | 2 | Ammo Pouch (bullets) |
| 2 | 4 | Soul Shard Bag |
| 5 | 32 | Herb Bag |
| 6 | 64 | Enchanting Bag (modern) |
Encoding deviation under the hood. 1.12 actually stores the raw 1-based BagFamily ID (
arrow=1, bullet=2, soul shard=3, herb=6, …). Modern WoW (Wrath+) flipped to the bitmask form for the same field. We convert on the way out viabitmask = 1 << (rawID - 1), so callers backporting from modern see the encoding they expect — addons canband(family, FAMILY_BAG_HERB_BAG)directly.
Item-level data is reliable; bag-level is sparse. Individual loot items (arrows, bullets, shards, herbs) carry the field reliably, so
C_Item.GetItemFamilyworks for the auto-routing use case. Bag containers themselves (Soul Pouch, Enchanting Bag, Herb Pouch, etc.) leave the field at 0 in vanilla server data — at least on Turtle WoW. If you need to know "is this bag specialty", read the bag'ssubClassviaC_Item.GetItemInfoInstantinstead. The Quiver class is fully populated; everything else needs the subClass fallback.
nilvs0. Modern WoW returns0for items the cache lookup fails on; we returnnilso callers can distinguish "item not cached, retry after the event lands" from "item exists but has no family preference." Both are safe to treat as0for routing-logic purposes; the distinction helps debugging.
Auto-warmup on cache miss. First call for an uncached item returns
nilAND triggers the engine's cache fill in the background. Listen forGET_ITEM_INFO_RECEIVED(itemID, success)and retry once the matchingitemIDarrives. This matches Classic Era 1.15's observed behavior of "nil first call, value second call." We diverge from 1.15 in one detail: 1.15'sGetItemFamilydoesn't fire any event when the cache lands (silent fill), whereas we fireGET_ITEM_INFO_RECEIVEDto stay consistent with our other implicit- warmup paths (GetItemInfo,SetItemByID). Addons that already listen for that event get the notification for free.
Equivalent to the legacy global GetItemFamily (since 3.0) and the
modern C_Item.GetItemFamily introduced in 10.x.
C_Item.GetItemCount(itemInfo, [includeBank], [includeUses])
Returns the player's total count of itemInfo — equipped items +
bags, and optionally bank.
count = C_Item.GetItemCount(itemInfo [, includeBank [, includeUses]])
itemInfo— numericitemIDor string containing"item:NNN"(full chat links work). Item names are NOT accepted (vanilla has no name → ID resolver).includeBank(optional, default false) — also walk bank slots (bag-1for the main bank, bags5..10for bank-bag slots).includeUses(optional, default false) — whentrue, multiplies each match by the item's spell-charges count. A wand with 50 charges contributes 50 instead of 1. Items without charges pass their plain stack count through unchanged, so the flag is a no-op for them.
local n = C_Item.GetItemCount(2589) -- Linen Cloth in bags + equipped
local n = C_Item.GetItemCount(2589, true) -- + bank
local n = C_Item.GetItemCount("item:2589") -- string form works too
-- Equipped items count toward the total:
local trinketID = GetInventoryItemID("player", INVSLOT_TRINKET1)
C_Item.GetItemCount(trinketID) -- 1
-- includeUses multiplies by charges for charged items:
C_Item.GetItemCount(wandID, false, true) -- 50 for one 50-charge wand
C_Item.GetItemCount(linenID, false, true) -- same as stack count (no charges)
Bank works cold — no banker visit required. The 1.12 server sends bank inventory at login alongside the rest of the player's data; only the engine's own
GetItemBySlotgates bank slots until the window opens. We bypass that gate by reading the GUID array directly out of the player invMgr and resolving each entry via the engine's object resolver — same pathGetItemBySlotwould take internally if the gate let us through. Counts are correct from session start.
Walks the 19 equipment slots via
Item::Location::ResolveEquipmentSlot, then bags via the same
Item::Location::ResolveBag chain
C_Container.GetContainerItemID
uses. Slot counts come from the engine's Script_GetContainerNumSlots
so custom server bag sizes work transparently. Stack counts read
directly off the CGItem's m_objectFields descriptor at +0x20
(ITEM_FIELD_STACK_COUNT, verified by decoding
Script_GetContainerItemInfo at 0x004F9670).
Equivalent to the legacy global GetItemCount (since 3.0) and the
modern C_Item.GetItemCount introduced in 10.x.
GetItemIcon(itemID) / C_Item.GetItemIcon(itemLocation) / C_Item.GetItemIconByID(item)
Three accessors that all return the icon path for an item, differing only in how you address the item:
| Function | Input |
|---|---|
GetItemIcon(itemID) |
numeric itemID (global) |
C_Item.GetItemIcon(itemLocation) |
{equipmentSlotIndex=N} or {bagID=B, slotIndex=S} |
C_Item.GetItemIconByID(item) |
numeric itemID OR "item:NNN" string (full chat links work) |
All three return the icon path string (e.g. "Interface\\Icons\\INV_Misc_Rune_01"),
or nil if the item isn't in the client-side cache, the slot is empty, or
the display info record is missing. The path is suitable for direct use
with texture:SetTexture(...).
local path = GetItemIcon(6948) -- "Interface\\Icons\\INV_Misc_Rune_01"
local path = C_Item.GetItemIcon({equipmentSlotIndex = INVSLOT_HEAD})
local path = C_Item.GetItemIconByID("|cff...|Hitem:6948:0:0:0|h[Hearthstone]|h|r")
iconID-vs-path deviation. Modern WoW returns these as afileID:number(specificallyiconFileIDin Classic Era 1.15.x). 1.12 has no fileID system — same situation asC_Spell.GetSpellTextureandC_Spell.GetSpellInfo'siconIDfield. We surface the path string everywhere for consistency.
Equivalent to the legacy global GetItemIcon (since 1.x) and the
C_Item.GetItemIcon / GetItemIconByID family added in 10.x.
C_Item.GetItemInfoInstant(item)
Modern-style accessor for the always-available subset of item info — the
fields that depend only on classification, not on player-specific state.
Returns immediately from the client-side item cache; no server round-trip,
no async polling. Returns nil if the item isn't in cache.
Accepts a numeric itemID or a string containing "item:NNN" (matches both
the bare "item:1234" shorthand and full chat links like
"|cff...|Hitem:1234:...|h[Name]|h|r"). Item names are not accepted —
vanilla itself has no name → ID resolver, and it's rarely the form addon code
actually has on hand.
Returns seven values:
itemID, itemType, itemSubType, itemEquipLoc, icon, classID, subClassID
itemType/itemSubTypeare the localized class / subclass names (e.g."Weapon"/"One-Handed Swords"), read fromItemClass.dbcandItemSubClass.dbc.itemEquipLocis the"INVTYPE_*"constant (e.g."INVTYPE_HEAD"), or""for non-equippable items.iconis a path string ("Interface\\Icons\\..."), matching what the rest of the 1.12 API returns. Modern WoW returns a numeric fileID here, but 1.12 has no fileID system, so a path is the only meaningful value.classID/subClassIDare the raw enum integers (e.g.2,7for one-handed swords).
local id, type, subtype, equipLoc, icon, classID, subClassID
= C_Item.GetItemInfoInstant(6948) -- Hearthstone
-- type="Miscellaneous", subtype="Junk", equipLoc="",
-- icon="Interface\\Icons\\INV_Misc_Rune_01", classID=15, subClassID=0
The actual class/subclass values reflect 1.12.1's data, which differs from
modern WoW. For example, vanilla had no Cloth subclass under Trade Goods —
Silk Cloth lives at (7, 0) in this client, not the modern (7, 5).
C_Item.IsItemDataCachedByID(item) / C_Item.IsItemDataCached(itemLocation)
Returns true if the item's static data is currently in the client-side
item cache, false otherwise. The "ByID" variant takes an itemID or
"item:NNN"-style string; the location variant takes the modern
{equipmentSlotIndex=} / {bagID=, slotIndex=} table.
These read the cache without firing a server query — pair with
RequestLoadItemData(ByID) if you need to ensure the data is loaded
before checking.
if not C_Item.IsItemDataCachedByID(itemID) then
C_Item.RequestLoadItemDataByID(itemID)
-- (poll IsItemDataCachedByID on a timer until true)
end
C_Item.RequestLoadItemDataByID(item) / C_Item.RequestLoadItemData(itemLocation)
Asks the engine to fetch the item's data from the server if not already
cached. Returns true if the request was initiated (or the input was
parseable to an itemID), false for malformed input. Fire-and-forget —
the engine handles the round-trip; the data lands in the cache when the
server responds.
Fires ITEM_DATA_LOAD_RESULT(itemID, success) when the data lands in
the cache, matching the modern API. Synchronously fired when the item
was already cached (so polling code paths still work), asynchronously
fired when the engine's SMSG response handler completes a network
fetch.
Vanilla quirk: the engine has no native bool format code —
successarrives as1/0(number), nottrue/false. Idiomatic check isif success == 1 then ....
local f = CreateFrame("Frame")
f:RegisterEvent("ITEM_DATA_LOAD_RESULT")
f:SetScript("OnEvent", function()
-- vanilla 1.12: event payload is in `arg1`, `arg2`, ... globals
if event == "ITEM_DATA_LOAD_RESULT" and arg2 == 1 then
local _, type = C_Item.GetItemInfoInstant(arg1)
-- ...
end
end)
C_Item.RequestLoadItemDataByID(2589)
C_Item.GetItemSpell(item)
Returns (spellName, spellID) for the on-use spell attached to an
item (potions, trinkets, scrolls, hearthstone, food/drink, etc.),
or nil for items without one (vendor trash, regular gear, weapons
with passive procs).
item accepts the same input shapes as GetItemInfo — a numeric
itemID, a chat-link "|cffffffff|Hitem:6948:0:0:0|h[...]|h|r"
fragment, or a "item:NNN" short form.
C_Item.GetItemSpell(6948)
-- "Hearthstone", 8690
C_Item.GetItemSpell(13442)
-- "Mighty Rage Potion", 17528
C_Item.GetItemSpell(11288) -- a soulstone (trigger=4, not ON_USE)
-- nil
C_Item.GetItemSpell(2589) -- Linen Cloth, no spell
-- nil
Returns the ON_USE spell only. Vanilla items can carry up to 5
spell entries in their ItemStats_C record, each with its own
trigger code:
| Trigger | Meaning | Surfaced by GetItemSpell? |
|---|---|---|
| 0 | ON_USE |
yes |
| 1 | ON_EQUIP (passive aura on gear) |
no |
| 2 | CHANCE_ON_HIT (weapon procs) |
no |
| 4 | SOULSTONE (on-death) |
no |
| 5 | ON_USE_NO_DELAY |
no (TODO: should we add this?) |
| 6 | LEARN_SPELL (recipes) |
no |
This matches modern WoW's GetItemSpell, which only reports on-use
triggers. Addons that need the other trigger types (proc auras,
recipe targets) should reach into the cache directly — the spell
slots are at ItemStats +0x11C (5 spell IDs) and +0x130 (5 trigger
codes).
Auto-warmup on cache miss. Items not yet in the local cache
return nil and silently kick off an SMSG_ITEM_QUERY_SINGLE
request. A second call after GET_ITEM_INFO_RECEIVED lands the
data. Same warmup pattern as C_Item.GetItemFamily and the rest of
our cache-backed accessors.
OffhandHasWeapon()
Returns true if the player has a one-handed weapon (or off-hand-only
weapon) equipped in the off-hand slot, false otherwise. Used by
dual-wield checks and any addon backporting modern weapon-equipment
logic.
Returns false for:
- Empty off-hand
- Shields (
INVTYPE_SHIELD) - Held items — tomes, orbs, librams (
INVTYPE_HOLDABLE) - Off-hand item data not yet cached (typically only on first login, before the engine has the item record; warms up after a peek)
Returns true for INVTYPE_WEAPON (any one-handed weapon — sword,
axe, mace, dagger, fist) and INVTYPE_WEAPONOFFHAND (off-hand-only
weapons). Two-handers occupy the main-hand slot exclusively, so they
never apply.
if OffhandHasWeapon() then
-- Apply mainhand+offhand poison, refresh dual-wield rotation, etc.
end
C_Item.IsEquippableItem(item)
Returns true if item can be equipped in any character-pane slot,
false otherwise. Reads m_inventoryType from the cached ItemStats
record — INVTYPE_NON_EQUIP (value 0) is the only "not equippable"
value, so any non-zero inventory type passes (head, neck, weapon,
shield, holdable, …).
item is an itemID number or "item:N..." link. Item names aren't
accepted — vanilla has no name→ID resolver, and equippability is an
itemID-keyed property anyway.
Returns false for uncached items (no async load fired). If you
need it to wait for the cache, call C_Item.RequestLoadItemDataByID
first and re-check on ITEM_DATA_LOAD_RESULT.
C_Item.IsEquippableItem(12640) -- Lionheart Helm → true
C_Item.IsEquippableItem(6948) -- Hearthstone → false
C_Item.IsEquippedItem(item)
Returns true if item is currently equipped in any of the 19
character-pane slots, false otherwise. Walks slots 1..19 in order and
short-circuits on the first match.
item accepts the same shapes as GetItemInfo:
| Form | Example | Match strategy |
|---|---|---|
| itemID | 2589 |
exact itemID equality |
| bare link | "item:2589:0:0:0" |
parses the first numeric field |
| chat link | \124cffffffff\124Hitem:2589:0:0:0\124h[Linen Cloth]\124h\124r |
extracts itemID after \124Hitem: |
| name | "Linen Cloth" |
case-insensitive match against the cached m_name[0] of each equipped item |
Returns false (no Lua error) for invalid input — nil, empty string,
or a string that doesn't parse as any of the above.
The name-match path requires the candidate equipped item to be in the client item cache; equipped items are always cached, so this is a non-issue in practice.
if C_Item.IsEquippedItem(2589) then
-- Linen Cloth is equipped (silly example — pick a wearable item)
end
-- From a chat link click:
if C_Item.IsEquippedItem(itemLink) then ...
-- By localized name:
if C_Item.IsEquippedItem("Thunderfury, Blessed Blade of the Windseeker") then ...
C_Item.EquipItemByName(itemInfo [, dstSlot])
Finds the first item in the player's bags matching itemInfo and
equips it. With dstSlot (a 1-based character-pane slot, 1..19),
equips to that specific slot; without, the engine auto-picks based on
the item's inventory type.
itemInfo accepts the same shapes as
C_Item.IsEquippedItem — itemID number,
bare "item:N" string, full chat link, or a localized item name. Name
matches are case-insensitive against the cached m_name[0].
Returns nothing. Silently no-ops when:
- the input is
nil, an empty string, or otherwise unparseable - no matching item is in bags (already-equipped items aren't moved — matches modern API behavior)
- the engine refuses the equip — combat, locked item, type mismatch
with
dstSlot, locked equipment slot, etc.
Two paths based on dstSlot:
- Explicit
dstSlot(1..19): cursor-free direct swap. Calls the engine's ownFUN_INVENTORY_SWAP(0x005E0C40) — the same primitiveScript_EquipCursorItemdispatches to after resolving cursor state. We hand it the source item GUID, source container GUID, source linear slot, and target paperdoll slot; the engine builds and sends the CMSG_SWAP_INV_ITEM (or CMSG_AUTOEQUIP_ITEM for cross-container) packet through its normal pipeline. The cursor is never read or written. An item already on the cursor stays on the cursor. - No
dstSlot(engine auto-picks slot from inventory type): falls back to the cursor-pickup +AutoEquipCursorItempath because 1.12's auto-pick logic reads off cursor state. For this path only, the function refuses to operate (no-op) whenCursorHasItem()is already true, to avoid clobbering whatever's held.
-- By itemID, auto-pick slot:
C_Item.EquipItemByName(2589)
-- By name, force into off-hand (slot 17):
C_Item.EquipItemByName("Linen Cloth", 17)
-- From a chat link:
C_Item.EquipItemByName(itemLink)
C_Item.DoesItemExist(itemLocation) / C_Item.DoesItemExistByID(item)
Existence checks straight off the engine's inventory manager (location
form) and item cache (ID form). No GetItemInfo chaining — both
functions read directly from the structures they need.
C_Item.DoesItemExist(itemLocation)—trueiff the equipment-slot or(bagID, slotIndex)location resolves to a populated inventory slot on the active player. Empty slots, missing bags, or malformed tables returnfalse.C_Item.DoesItemExistByID(item)—trueiff the cache currently has data foritem. Cache miss returnsfalseand kicks off the network query in the background; a follow-up call afterGET_ITEM_INFO_RECEIVEDwill succeed. Accepts a numericitemID, a bare"item:NNN..."string, or a full chat link.
if C_Item.DoesItemExist({equipmentSlotIndex = INVSLOT_HEAD}) then ... end
if C_Item.DoesItemExistByID(6948) then ... end
C_Item.GetItemName(itemLocation) / C_Item.GetItemNameByID(item)
Returns the cached display name as a string, or nil for empty /
uncached / invalid inputs. Reads m_name[0] straight off the
ItemStats_C cache record (+0x08) — no GetItemInfo round-trip.
Cache miss on the ByID form returns nil and fires the cache fill
so the next call (after GET_ITEM_INFO_RECEIVED) succeeds.
local name = C_Item.GetItemName({bagID = 0, slotIndex = 1})
local name = C_Item.GetItemNameByID(6948) -- "Hearthstone"
C_Item.GetItemQuality(itemLocation) / C_Item.GetItemQualityByID(item)
Returns the item's quality as an integer (0=Poor, 1=Common, 2=Uncommon,
3=Rare, 4=Epic, 5=Legendary), matching the LE_ITEM_QUALITY_*
constants. Single uint32 read at cache record +0x1C.
if C_Item.GetItemQualityByID(itemID) >= LE_ITEM_QUALITY_RARE then
-- highlight rare-or-better drop
end
C_Item.GetItemSetID(itemLocation) / C_Item.GetItemSetIDByID(item)
Returns the ItemSet.dbc ID for the item if it's part of an
equipment set (e.g., 181 for any Magister's Regalia piece), or
nil if the item isn't part of any set / the item isn't cached /
the slot is empty.
local setID = C_Item.GetItemSetIDByID(16682) -- Magister's Regalia: 181
local setID = C_Item.GetItemSetIDByID(6948) -- Hearthstone: nil
-- by itemLocation (worn or in-bag)
local chestSet = C_Item.GetItemSetID({ equipmentSlotIndex = 5 })
This is the 16th return of modern WoW's GetItemInfo (the setID
field). Single uint32 read at cache record +0x1C0
(m_itemSet). Same cache-warm pattern as the other *ByID getters
— cache misses return nil and fire a background load; call
C_Item.RequestLoadItemDataByID(itemID) if you need synchronous-
after-event resolution.
C_Item.GetItemSetInfo(setID)
Returns a table describing the item set, or nil if setID
doesn't resolve to an ItemSet.dbc row.
local info = C_Item.GetItemSetInfo(181)
-- {
-- setID = 181,
-- name = "Magister's Regalia",
-- requiredSkill = 0,
-- requiredSkillRank = 0,
-- items = { 16685, 16683, 16686, 16684, 16687, 16689, 16688, 16682 },
-- bonuses = {
-- { spellID = 29091, threshold = 2 }, -- 2-piece bonus
-- { spellID = 27867, threshold = 6 }, -- 6-piece bonus
-- { spellID = 18679, threshold = 8 }, -- 8-piece bonus
-- { spellID = 30777, threshold = 4 }, -- 4-piece bonus
-- },
-- }
| Field | Type | Notes |
|---|---|---|
setID |
number | Echo of the input. |
name |
string | Localized set name. |
requiredSkill |
number | Skill line ID required to use the set; 0 if none. |
requiredSkillRank |
number | Required rank in that skill line; 0 if none. |
items |
array | itemIDs in the set. Empty slots filtered, so #info.items is the real item count. Order is the engine's own (matches the set's order in the DBC; not necessarily slot-sorted). |
bonuses |
array | { spellID, threshold } tables for each non-empty set-bonus slot. threshold is the number of equipped set pieces required to grant spellID. Order is the DBC's; bonuses with the same threshold are not normalized. |
Reads ItemSet.dbc directly — no cache warm-up needed (DBCs load at
boot). Returns nil for setID == 0, out-of-range IDs, or rows
that don't exist.
C_Item.GetItemSellPrice(itemLocation) / C_Item.GetItemSellPriceByID(item)
Returns the vendor sell price in copper, per unit (multiply by
stack count for the per-stack value). Matches the 11th return of
modern WoW's GetItemInfo. Returns nil on cache miss / invalid
input. Cache miss fires a background fill so a follow-up call after
GET_ITEM_INFO_RECEIVED returns the value.
local unit = C_Item.GetItemSellPriceByID(2589) -- Linen Cloth → 25 (copper)
local stack = unit * C_Item.GetItemMaxStackSizeByID(2589)
Single uint32 read at cache record +0x28 (m_sellPrice). Vanilla
1.12 doesn't surface this in tooltips — the field is populated on
every sellable item but the engine's tooltip code never reads it —
so this function exposes data that's been sitting in the cache
unused.
C_Item.GetCurrentItemLevel(itemLocation) / C_Item.GetDetailedItemLevelInfo(item)
Returns the item's base ilvl from m_itemLevel (cache record +0x38).
Vanilla 1.12 has no per-instance scaling (no upgrades, no warforging),
so "current" and "base" item level are always identical — both APIs
return the same single value. Modern GetDetailedItemLevelInfo is
spec'd to return (current, isPreview, base); we push only the
current level, callers that care about the extra returns will see
nil for them.
local ilvl = C_Item.GetCurrentItemLevel({equipmentSlotIndex = INVSLOT_HEAD})
GetAverageItemLevel()
Returns (avgItemLevel, avgItemLevelEquipped) — modern WoW's
2-tuple shape. avgItemLevelEquipped is the arithmetic mean over
the player's currently-worn equipment slots; avgItemLevel is the
same metric but extended to include best-per-slot upgrades found
anywhere in the player's bags and bank.
Slots considered: INVSLOT_HEAD..INVSLOT_TABARD (1..19) minus
shirt (4) and tabard (19) = 17 candidate slots. Bag-walk uses the
same invType → slotMask mapping as GetInventoryItemsForSlot.
local overall, equipped = GetAverageItemLevel()
-- overall: best-per-slot ilvl across equipped + bags + bank
-- equipped: ilvl of currently-worn items only
Fixed denominator. Empty slots count toward the denominator
(contributing 0 to the sum). Removing a piece of gear always
lowers avgItemLevelEquipped — matches modern's behavior
(verified against retail Wow.exe at 552.4375 × 16 = 8839
exactly). Vanilla addons of the GearScore era used populated-only
count; this implementation deliberately differs.
Max-of-two-divisors fairness. A 2H weapon wielder has an
intentionally empty offhand (slot 17) — counting it as 0 in a
17-divisor sum would unfairly penalize them. We compute a second
candidate excluding slot 17 from both numerator and denominator
(16 slots), and return the max. Sword+shield characters typically
win the all-17 path; 2H wielders win the no-OH path. Same trick
the 4.3.4 client uses at FUN_0097E0F0's tail.
No double-counting. Each bag/bank item is assigned to one candidate slot via greedy fit — a trinket in your bag fills one trinket slot (the empty/lower-best one), not both. Without this gate, moving a trinket from equipped to bag would inflate the "overall" count and drag the average down (because the same item would count for both trinket slots).
Bank is walked even if the bank window has never been opened
this session — the GUID array at invMgr + 0x04 is populated
from server data at login. Bypasses the bank-window gate on
GetItemBySlot the same way C_Item.GetItemCount does.
Limitations:
- Items not yet in the ItemStats cache are skipped from the
running totals and a warmup is queued; the next call after
ITEM_DATA_LOAD_RESULTlands picks them up. - The full 4.3.4 weapon
qsortdance — handling 2H-equipped vs. 1H + OH-in-bag comparisons — is not replicated. Edge case in vanilla where you'd notice a difference is narrow.
C_Item.GetItemMaxStackSize(itemLocation) / C_Item.GetItemMaxStackSizeByID(item)
Returns the item type's max stack size — what you'd find as the 8th
return of GetItemInfo(item). 1 for non-stackable items; 5, 20,
200, etc. for stackables. Different from C_Item.GetStackCount /
the engine's GetContainerItemInfo, which return the current
count in a specific slot.
local cap = C_Item.GetItemMaxStackSizeByID(2589) -- Linen Cloth → 20
Single uint32 read at cache record +0x60 (m_stackable). By-ID
form fires a background cache fill on miss and returns nil; re-call
after GET_ITEM_INFO_RECEIVED.
C_Item.GetItemLink(itemLocation)
Returns the fully-decorated per-instance hyperlink for the item at
the location — same string GetContainerItemLink(bag, slot) or
GetInventoryItemLink("player", slot) would return for the same
slot. Enchant ID, random-suffix, and any other per-instance data
attached to the CGItem are preserved.
local link = C_Item.GetItemLink({bagID = 0, slotIndex = 1})
-- "|cffa335ee|Hitem:16539:911:::::::70::::::::::|h[General's Silk Boots]|h|r"
-- ^^^ — enchant ID (Speed +15%) preserved
Implemented by reading the location table's fields and tail-calling
the engine's link script function (Script_GetContainerItemLink at
0x004F9930 for bag locations, Script_GetInventoryItemLink at
0x004C8C10 for equipment slots). The link string is built by the
engine off the live CGItem, so it always matches what other
addons see via the older positional-arg APIs.
C_Item.GetItemInventoryType(itemLocation) / C_Item.GetItemInventoryTypeByID(item)
Returns the numeric Enum.InventoryType straight off the cache
record's m_inventoryType field (+0x2C) — the integer sibling of
GetItemInfoInstant's 4th return (which gives the INVTYPE_* string).
| Value | Constant | Slot |
|---|---|---|
| 0 | INVTYPE_NON_EQUIP_IGNORE |
non-equippable |
| 1 | INVTYPE_HEAD |
head |
| 2 | INVTYPE_NECK |
neck |
| … | … | … |
| 20 | INVTYPE_ROBE |
chest (full-body robes) |
| 26 | INVTYPE_RANGEDRIGHT |
ranged |
| 27 | INVTYPE_QUIVER |
quiver/ammo pouch |
Vanilla items only produce values 0..28; the higher modern
constants (INVTYPE_PROFESSION_*, INVTYPE_EQUIPABLESPELL_*, etc.)
were introduced post-vanilla and are never returned. Modern
backport code that compares against the higher enum values still
resolves correctly because vanilla items just don't carry those
types.
local t = C_Item.GetItemInventoryTypeByID(19019) -- Thunderfury: 17 = INVTYPE_2HWEAPON
if t == 1 then -- head
...
end
C_Item.IsLocked(itemLocation)
Returns true if the item is in the client-side "in-transaction"
lock state — picked up onto the cursor, mail-attached, trade-attached,
mid-swap, etc. Reads the per-CGItem instance flag at +0x314 bit 0
(not the ITEM_FIELD_FLAGS descriptor field — vanilla's actual lock
is on the instance, not in m_objectFields).
if C_Item.IsLocked({bagID = 0, slotIndex = 1}) then
-- skip the action; slot is mid-transaction
end
The lock is client-managed, server-confirmed:
- Engine sets the bit optimistically in pickup/equip/attach paths, before the transaction packet goes to the server. UI greys immediately, no round-trip wait.
- Engine clears the bit when the matching
SMSG_UPDATE_OBJECTconfirms the transaction.
Listen for the vanilla-native ITEM_LOCK_CHANGED event (no payload —
the engine fires it on every set/clear and addons re-poll the items
they care about) to react without timed polling.
C_Item.LockItem(itemLocation)
Set the client-side lock on a single item by location. Calls the same
engine primitive (FUN_ITEM_LOCK_BY_GUID = 0x004953E0) the engine
itself uses optimistically before sending pickup/equip transactions.
Fires ITEM_LOCK_CHANGED the same way.
C_Item.LockItem({bagID = 0, slotIndex = 1})
Setting the lock doesn't make anything real happen on the server. It's a pure client-side flag — the player's UI greys the item out until something clears it. No transaction packet is sent, no cancel-on-failure mechanism kicks in. Treat this as a UI hint for custom workflows (batch-equip preview, drag-target highlighting, etc.), not real transaction state.
The lock stays until you call
UnlockItem/UnlockAllItems, OR the engine receives an SMSG_UPDATE_OBJECT for the item from the server, which clears it as a side effect.
C_Item.LockItemByGUID(itemGUID)
Same as LockItem but takes a GUID
string in the canonical "0xHHHHHHHHLLLLLLLL" format
C_Item.GetItemGUID returns. The
engine resolves through the object manager, so this can mark items
the player doesn't currently have in bags/equipment — trade window
contents, mail attachments, freshly looted but not yet bagged — as
long as the CGItem is loaded.
local guid = C_Item.GetItemGUID({equipmentSlotIndex = INVSLOT_HEAD})
C_Item.LockItemByGUID(guid)
Same caveats as LockItem — purely client-side, doesn't affect any
real engine transaction state.
C_Item.UnlockItem(itemLocation)
Force-clear the client-side lock on one item. Recovery primitive —
fires ITEM_LOCK_CHANGED so the UI refreshes.
C_Item.UnlockItem({bagID = 0, slotIndex = 1})
Useful when a transaction packet was sent but the server's confirmation never arrived: the item stays visually greyed indefinitely (vanilla's only built-in trigger for the unlock-all sweep is logout). This call gives you an in-session escape hatch.
Cursor / server state isn't touched. Unlocking doesn't tell the server "cancel my transaction" — it only clears the local visual lock. If the item is genuinely mid-flight, the server's next update will set the lock right back. For cursor-cancel semantics, pair with vanilla-native
ClearCursor().
C_Item.UnlockAllItems()
Sweep clear of every CGItem the engine knows about — same primitive
the engine itself runs on PLAYER_LEAVING_WORLD. One
ITEM_LOCK_CHANGED fires at the end.
C_Item.UnlockAllItems()
Cheapest recovery if you don't know which item is stuck. Same caveat
as UnlockItem: this is purely client-side state — it won't cancel
any pending server-side transactions.
C_Item.GetItemGUID(itemLocation)
Returns the per-instance 64-bit GUID of the item at the location,
formatted as "0xHHHHHHHHLLLLLLLL" (16 hex digits, hi dword first).
Same format UnitGUID uses — 1.12 GUIDs are plain qwords with no
"Item-Server-..."-style prefix scheme (modern's prefix format
arrived in 6.x). Returns nil for empty / invalid locations.
local guid = C_Item.GetItemGUID({equipmentSlotIndex = INVSLOT_HEAD})
-- "0x40000000000DEFCA"
Reads CGItem instance block at +0x08 → GUID qword at +0x00.
The GUID is stable per-character-session and survives moves between
bags / character pane, so it's the right identifier for "this exact
item instance" — equipment-set tracking, soulbind matching, or any
addon code that needs to follow a single item across slot moves.
C_Item.GetItemLocation(itemGUID)
Reverse lookup from a GUID string (the format C_Item.GetItemGUID
returns) to an itemLocation table identifying the slot currently
holding that item. Returns nil if the GUID isn't resident in the
walked scope.
local guid = C_Item.GetItemGUID({equipmentSlotIndex = INVSLOT_HEAD})
-- player moves item to bag, drops it, etc. — guid stays valid across
-- bag/equipment rearrangements until the item leaves the session
local loc = C_Item.GetItemLocation(guid)
-- loc might now be { bagID = 1, slotIndex = 4 }, or nil if sold
Modern WoW returns an ItemLocation mixin object; we return a plain
table with the same field shape every other C_Item.* API in
ClassicAPI accepts as input ({equipmentSlotIndex=N} or
{bagID=B, slotIndex=S}), so the result pipes straight into
C_Item.GetItemQuality(loc), C_Item.GetItemLink(loc), etc.
Walked scope. Character-pane equipment (slots 1..19) + backpack
(bagID 0) + the four equipped bags (bagIDs 1..4). Bank and keyring
are NOT walked — same scope as the rest of the C_Container.*
family. Worst case is ~80 slot lookups; fine for sporadic use, not
appropriate for per-frame polling.
Implementation. We don't go through the engine's typed
object-by-GUID helper at 0x00468460 (the one used for the auction-
sell slot) because that path asserts on bad input — stale GUIDs
from addon-side caching would crash the client. Instead we walk
equipment + bag slots, read each CGItem's GUID, and compare. Misses
return nil; hits never need a fallback.
Get*ItemID — companions to the engine's Get*ItemLink family
The 1.12 engine ships ~14 Get*ItemLink functions covering every
frame that lets you mouse over an item (loot, merchant, quests,
auction, trade, mail, tradeskill, craft). To get the itemID, the
standard pattern is to call the Link function and scrape the
number out of the returned string with gsub / match. Modern
WoW only has direct-ID accessors for a handful of these
(GetLootSlotItemID, GetInboxItemID, GetQuestItemID,
GetMerchantItemID, …), and the rest of the addon ecosystem still
scrapes the link.
These backport the modern ones where they exist and fill in the
gaps for the rest, so the whole Get*ItemLink family has a
1-to-1 ID companion. Each reads the same itemID the engine reads
when building the link, with no string parsing required.
All return nil for an empty slot, an out-of-range index, or when
the relevant UI frame isn't open.
| Function | Companion to | Notes |
|---|---|---|
GetLootRollItemID(rollID) |
GetLootRollItemLink |
Group-loot roll ID (from START_LOOT_ROLL). Walks the engine's in-progress roll list. |
GetLootSlotItemID(slot) |
GetLootSlotLink |
1-based slot. Returns nil for coin slots. |
GetMerchantItemID(index) |
GetMerchantItemLink |
1-based; the active merchant's inventory. |
GetQuestItemID(type, index) |
GetQuestItemLink |
type is "reward" or "choice"; active quest-offer / completion UI. |
GetQuestLogItemID(type, index) |
GetQuestLogItemLink |
Same args; reads the currently selected quest-log entry. |
GetTradePlayerItemID(slot) |
GetTradePlayerItemLink |
1..7; your side of the trade window. |
GetTradeTargetItemID(slot) |
GetTradeTargetItemLink |
1..7; the other player's side. |
GetAuctionItemID(type, index) |
GetAuctionItemLink |
type is "list", "owner", or "bidder". |
GetAuctionSellItemID() |
GetAuctionSellItemInfo |
The item currently in the sell slot. No args. |
GetInboxItemID(mailID) |
GetInboxItem |
1-based mail index; nil for gold-only mail. |
GetTradeSkillItemID(index) |
GetTradeSkillItemLink |
The recipe's created item itemID. |
GetTradeSkillReagentItemID(index, reagentIndex) |
GetTradeSkillReagentItemLink |
reagentIndex is 1-based; reagents are densely packed (no skipping empty slots). |
GetCraftReagentItemID(craftIndex, reagentIndex) |
GetCraftReagentItemLink |
Craft frame (enchanting / beast training) — same shape as tradeskill reagents. |
GetCraftSpellID(craftIndex) |
GetCraftItemLink |
The craft frame's link is Hspell:, not Hitem: — so the companion is a spellID, not an itemID. Addons scraping for itemID get nil today; this returns the actual identifier. |
-- Drop-in for the typical scrape:
-- local id = tonumber((GetLootRollItemLink(rollID)):match("item:(%d+)"))
local id = GetLootRollItemID(rollID)
-- Plays nice with the existing data APIs:
if id then
local _, _, _, _, _, classID = C_Item.GetItemInfoInstant(id)
-- ...
end
Quest UI distinction.
GetQuestItemIDreads the active quest offer (the QuestFrame you see when accepting/turning in a quest);GetQuestLogItemIDreads the currently-selected entry in the quest log. The two cover different states intentionally — modern WoW does the same split withGetQuestItemLink/GetQuestLogItemLink.
GetTradeSkillItemIDvsGetCraftSpellID. Vanilla splits recipes across two UI frames: TradeSkill (smithing / alchemy / tailoring / etc., which always produce a finished item) and Craft (enchanting formulas / beast-training tomes, where the spell IS the deliverable).GetTradeSkillItemIDreturns the produced itemID;GetCraftSpellIDreturns the recipe spellID — because there's no produced item to point at.
Macros
Engine-level extensions to how macros are parsed and dispatched. These
don't add new Lua functions — they teach the engine to recognize input
forms it didn't accept in stock 1.12. Macro authors get them for free
once ClassicAPI.dll is loaded.
Vanilla 1.12 doesn't support [target=...]-style macro conditionals
natively; we don't add those. If you have a separate DLL/addon that
does (nampower's conditional macros, SuperWoWhook, etc.), the
extensions below compose with it — that layer strips the bracket
clause and forwards the cleaned tail to CastSpellByName, which then
flows through our additions.
Numeric spellIDs in /cast and CastSpellByName
Pure-numeric input is now accepted anywhere a spell name would be:
/cast 5019 -- in a macro line; casts Shoot if known
CastSpellByName("5019") -- same effect from Lua / /run / chat
The spellID is resolved through Spell.dbc to the locale-resolved
name, then handed to the engine's existing name resolver — so all the
normal downstream behavior applies: the spellbook lookup gates on
"player knows this spell," action-bar UI sees the cast as if it had
been named, macros containing /cast 5019 get tagged with the right
spellID in the engine's spell-state cache (so IsCurrentAction(slot)
and IsAutoRepeatAction(slot) work for the macro slot).
| Input | Outcome |
|---|---|
/cast 5019 |
Casts Shoot if you know it (any rank, highest known) |
/cast 1234 |
Falls through as "unknown spell," same as /cast Foo |
/cast Shoot |
Unchanged from vanilla — names still work |
/cast 5019(Rank 1) |
Falls through — rank suffix with a numeric stem isn't supported (use the name form if you need a specific rank) |
Implemented as a single hook on the engine's name → spellbook-slot
resolver at 0x004B3950 — covers /cast, /castsequence aliases,
CastSpellByName, the macro parser's tagging path, and anywhere
else the engine resolves a spell name. Numeric input with garbage
trailing characters falls through unchanged.
CastSpellNoToggle as a macro cast line
Putting CastSpellNoToggle("Shoot") in a macro body now tags the
macro with Shoot's spellID the same way /cast Shoot or
CastSpellByName("Shoot") would. Without this, the macro casts
correctly but vanilla's macro parser doesn't know to associate the
slot with any spell — so action-bar UIs that call
IsCurrentAction(slot) / IsAutoRepeatAction(slot) (pfUI's
actionbar, ShaguTweaks, etc.) never light up the slot.
Recognized forms in a macro body:
CastSpellNoToggle("Shoot") -- by name (string)
CastSpellNoToggle("Cat Form") -- shapeshift / aspect / stance all tag the same way
CastSpellNoToggle(5019) -- not yet — macro parser only recognizes the string form
The numeric form works for the cast itself (via the function's
runtime resolution), but the macro parser only scans for the string
form when tagging. To get the slot to highlight when using the
spellID, write CastSpellNoToggle("Shoot") instead.
The engine's first-match-wins rule still applies — if your macro is:
/cast Wand
CastSpellNoToggle("Shoot")
…the macro is tagged with Wand (the engine recognized /cast Wand
on line 1; our additional pattern is only consulted when the engine
didn't find any of its own patterns).
Macro tagging happens at macro edit/save time. Existing macros need to be opened in the Macro UI and re-saved once after dropping in the new DLL to pick up the new parser behavior.
GetMacroSpell(macroSlot)
Returns (name, rank, spellID) for the spell a macro's first /cast
/ /castsequence / CastSpellByName(...) directive resolves to, or
nothing when the macro slot is empty, contains no cast directive, or
the directive's name doesn't resolve to a spell the player knows.
-- macro slot 1's body: "/cast Fireball(Rank 5)"
local name, rank, id = GetMacroSpell(1)
-- name = "Fireball", rank = "Rank 5", id = 25306
-- macro slot 2's body: "/cast Fireball" (no explicit rank)
local name, rank, id = GetMacroSpell(2)
-- name = "Fireball", rank = "Rank 5", id = 25306 (the highest known rank)
-- macro slot 3's body: only /script lines or no cast
GetMacroSpell(3)
-- (no returns)
No body parsing happens at call time — the vanilla engine already
walks every macro body at create / edit / refresh and caches the
resolved spellID on the macro struct. We just read the cache and
look the name + rank up in Spell.dbc. Result: O(1) per call.
CastSpellNoToggle("<name>") macros are also recognized — the
parser hook from the CastSpellNoToggle
section tags them with the same spellID a /cast line would, so
GetMacroSpell sees them too.
Re-save existing macros once after dropping in the DLL. The spellID cache is populated at edit time. Macros that existed before ClassicAPI loaded (or that use
CastSpellNoToggleand were last edited under stock 1.12) will have a stale0cache — opening them in the Macro UI and clicking Okay re-runs the parser and the new behavior takes effect.
MerchantFrame
Backports the six C_MerchantFrame.* calls retail addons use when
interacting with a vendor. All entry points read the engine's
merchant/buyback storage directly — no Lua-roundtrip through
GetMerchantItemInfo / GetBuybackItemLink etc. — and the
SellAllJunkItems dispatcher bypasses UseContainerItem entirely
by calling the engine's internal MerchantSellItem packet builder.
A "merchant frame is currently open" gate (VAR_MERCHANT_NPC_GUID_*
non-zero) applies to every function — the same gate retail enforces.
GetNumJunkItems returns 0 away from a vendor and the sell
functions are no-ops; the per-slot getters return nil.
C_MerchantFrame.GetItemInfo(slot)
Returns a table describing the merchant's item at the given 1-based
slot, or nil if no merchant is open / the slot is out of range.
Table fields:
| Field | Type | Notes |
|---|---|---|
itemID |
number | Item record key, suitable for C_Item.GetItemInfoInstant / cache lookups. |
price |
number | Copper cost per stack (multiply by stackCount for unit price). |
stackCount |
number | Units delivered per purchase (1 for most equipment, e.g. 5 for stacks of cloth). |
numAvailable |
number | Limited-supply count, or -1 for unlimited stock. |
isPurchasable |
boolean | Always true in this build — vanilla has no "blocked from buying" flag. |
isThrottled |
boolean | Always false — modern's anti-spam concept doesn't apply in vanilla. |
hasExtendedCost |
boolean | Always false — currency/honor-cost merchants don't exist in vanilla. |
local info = C_MerchantFrame.GetItemInfo(1)
if info then
print(info.itemID, info.price, info.stackCount)
end
Reads directly from the 28-byte merchant entry at
VAR_MERCHANT_ITEMS + (slot-1) * MERCHANT_STRIDE (the same flat
array Script_GetMerchantItemInfo walks). Compared to the existing
GetMerchantItemID,
this returns the wider modern struct shape in one call.
C_MerchantFrame.GetBuybackItemID(slot)
Returns the itemID of the merchant's buyback slot at the given
1-based index (1..12), or nil if the slot is empty / no merchant
is open.
for slot = 1, 12 do
local id = C_MerchantFrame.GetBuybackItemID(slot)
if id then
-- buybackable item at slot
end
end
Resolution chain (engine-direct, no Lua-side GetBuybackItemLink
roundtrip):
- Read the buyback slot's stored invMgr index from
VAR_BUYBACK_SLOTS + (slot-1)*4. - Look up that index in the player invMgr's flat GUID array (the engine keeps sold items alive in the player's inventory storage, not in a separate buyback pool).
- Resolve the GUID to a
CGItem*viaItem::Location::ResolveByGUID— same engine helperC_EquipmentSet.GetItemLocationsuses. - Read the itemID from the CGItem's instance block at
+0x08 + 0x0C.
C_MerchantFrame.GetNumJunkItems()
Returns the count of grey-quality (LE_ITEM_QUALITY_POOR) items in
the player's bags 0..4 that SellAllJunkItems would sell. Returns
0 when no merchant frame is open — matching retail's behavior of
gating the count on merchant context, since the count is meant as
a "what would the sell-junk button do right now" signal rather than
a passive inventory query.
-- Inside a MERCHANT_SHOW handler:
local junk = C_MerchantFrame.GetNumJunkItems()
if junk > 0 then
print("Selling " .. junk .. " junk item(s)")
C_MerchantFrame.SellAllJunkItems()
end
Quality is read from each item's ItemStats cache record at the
m_quality field (OFF_ITEMSTATS_QUALITY = 0x1C). Items with
unloaded cache records (rare for items in your own bags) are
skipped — same conservative behavior the sell path uses.
C_MerchantFrame.SellAllJunkItems()
Sells every quality-0 item in the player's bags to the open merchant. No-op when no merchant frame is open.
Sells are dispatched one per frame via the shared
WorldTick subscriber, not in a tight loop within the call —
vanilla's network path drops packets when CMSG_SELL_ITEM is
flooded (a 10-item burst consistently lost the 2nd-to-last sell
in testing). Calling pace matches click-by-click selling. For
10 junk items, expect the queue to drain in ~10 frames (~150ms
at 60fps).
C_MerchantFrame.SellAllJunkItems()
If the player closes the merchant frame or opens a different vendor mid-drain, the remaining queue is discarded rather than mis-routed to the new merchant.
Each sell is delivered via the engine's internal
MerchantSellItem helper (FUN_MERCHANT_SELL_ITEM, opcode
CMSG_SELL_ITEM/0x1A0) called with count = 0 ("sell whole
stack"). Bypasses Script_UseContainerItem entirely — addons
hooking UseContainerItem will not see these sells, and there's
no risk of the use-not-sell dispatch branch firing if the merchant
state changes mid-loop.
C_MerchantFrame.IsMerchantItemRefundable(slot)
Always returns false. Vanilla 1.12 has no refund mechanic
(retail's 2-hour buy-back-for-full-price system was introduced
post-vanilla); the function exists for API parity so retail
addons that gate behavior on refundability don't break.
if not C_MerchantFrame.IsMerchantItemRefundable(slot) then
-- always taken in this build
end
C_MerchantFrame.IsSellAllJunkEnabled()
Always returns true. Retail exposes an optional client setting to
disable the sell-all-junk button; vanilla has no such setting, so
the feature is always on. Function exists so retail addons that
gate SellAllJunkItems on this don't no-op silently.
NameCache
GUID-keyed cache of player names and classes. The engine itself
maintains an in-memory NameCache at 0x00C0E228, populated by
SMSG_NAME_QUERY_RESPONSE — but vanilla doesn't expose it to Lua,
and it doesn't survive /reload. This module surfaces it as
GetPlayerInfoByGUID, adds an opt-in persistent layer that
survives /reload and full client restarts, and (separately
toggleable) sweeps the engine's visible-object list to populate
entries the SMSG path would never reach on its own.
Two toggles, each independent:
C_PlayerCache.SetEnabled— turn on the on-disk cache. Off by default. Without this, the module is read-only against the engine's transient in-memory cache.C_PlayerCache.SetScanEnabled— turn on the visible-object sweep. Off by default. Requires the on-disk cache to be enabled to have any effect.
Three population sources feed the cache when fully enabled:
SMSG_NAME_QUERY_RESPONSEhook (always active when the on-disk cache is on). Every name-query response the engine processes is mirrored to disk. Covers chat, group/raid sync, guild updates, visible-object resolution — anything the engine itself issues a name query for.C_PlayerCache.RememberPlayer(always available, no-op when the cache is off). Lets addons feed in sources the engine never sees:/whoresults, etc.- Visible-object sweep (active when both toggles are on).
Walks the engine's live visible-object list every ~10 seconds
on the
Frame::RegisterEventhook, resolving each player and feeding name + class. Picks up nearby players whether or not the engine ever queried them.
Storage:
WTF\Account\<account>\ClassicAPI.txt— account-level settings (PersistentNameCacheEnabled,NameCacheScanEnabled).WTF\Account\<account>\<realm>\ClassicAPI_NameCache.txt— per-realm cache. Tab-separated text, ~30 bytes/entry, hand-editable. Shared across all characters on the same account+realm (a 50-character bank alt's chat scraping doesn't double the storage cost).
GetPlayerInfoByGUID(guid)
Returns
localizedClass, englishClass, localizedRace, englishRace, sex, name, realm
for a player GUID the engine has cached, or nil on a cache miss.
local _, class, _, race, sex, name = GetPlayerInfoByGUID(UnitGUID("target"))
-- e.g. "WARRIOR", "NightElf", 2, "Sylphir"
GetPlayerInfoByGUID("0x0000000000000777") -- same shape for a literal GUID
guid is the "0xHHHHHHHHLLLLLLLL" string returned by UnitGUID.
Bare 8-hex "0xLLLLLLLL" (hi-dword zero) is also accepted.
Returns:
| 1 localizedClass | "Warrior" / "Krieger" etc. — from ChrClasses.dbc indexed by locale. |
| 2 englishClass | "WARRIOR" (uppercase tag, same value UnitClass returns as 2nd return on modern clients) — ChrClasses.dbc filename field. |
| 3 localizedRace | "Human" / "Mensch" / "Humain" etc. — from ChrRaces.dbc indexed by locale. |
| 4 englishRace | "Human", "Orc", "Dwarf", "NightElf", "Scourge" (vanilla's filename for what addons call Undead), "Tauren", "Gnome", "Troll" — from ChrRaces.dbc filename field. |
| 5 sex | 2 = male, 3 = female. Matches UnitSex convention (the cache stores 0/1; we add 2). |
| 6 name | Character name. |
| 7 realm | Realm name. Single-realm in vanilla, so usually the local realm. |
Cache coverage: the engine populates entries from
SMSG_NAME_QUERY_RESPONSE. Anything the client has already seen
populates the cache: chat (whispers, says, party chat), raid/group
events, guild updates, visible objects (target, party, raid in
zone). Names of offline friends never seen in chat are not
cached — GetPlayerInfoByGUID returns nil for them until the
client does something that triggers a name query. This module
deliberately does not trigger queries from a passive getter; a
future C_PlayerInfo.RequestLoadPlayerByID would do that
explicitly and fire a load-result event.
Persistent fallback: when
C_PlayerCache.SetEnabled(true)
has been opted into, a per-realm on-disk cache extends coverage
across sessions. On engine cache miss, GetPlayerInfoByGUID falls
back to the persistent cache and returns name, class, race,
and sex from storage (realm comes back as "" since vanilla
is single-realm and we don't carry per-player realm names).
Returns nil only when both the engine and persistent caches miss.
Implementation: calls the engine's get-or-fetch primitive at
0x0055F080 with a NULL callback (pure cache read). The cache
instance lives at 0x00C0E228; entry layout (name, realm, race,
sex, class) was reverse-engineered from the
SMSG_NAME_QUERY_RESPONSE write path at 0x0055F310.
C_PlayerCache.GetPlayerInfoByName(name)
Returns
localizedClass, englishClass, localizedRace, englishRace, sex, name, realm, guid
for a player in the persistent NameCache, or nil if the name
isn't cached. Companion to GetPlayerInfoByGUID for the case where
an addon has a player's name but not their GUID — e.g., when
GetCurrentChatGUID() returns nil for a chat event the engine
didn't tag with the sender GUID (system notifications, some channel
messages, etc.).
local _, class, _, race, _, _, _, guid = C_PlayerCache.GetPlayerInfoByName("Gedwyr")
-- "MAGE", "Human", "0x000000003B9ADAA7"
C_PlayerCache.GetPlayerInfoByName("NeverSeen") -- nil (not cached)
Match is case-sensitive, exact — vanilla server-stored names
are case-stable ("Gedwyr" won't match "gedwyr").
Returns (vs. GetPlayerInfoByGUID):
| Slot | Value | Notes |
|---|---|---|
| 1–7 | same as GetPlayerInfoByGUID |
see above |
| 8 | guid |
"0xHHHHHHHHLLLLLLLL" — the cached player's full GUID, so name-based callers can chain into GUID-keyed APIs. Absent from GetPlayerInfoByGUID since the caller already has it. |
Only reads from the persistent NameCache — does not hit the
engine's in-memory NAME_QUERY cache (that's keyed by GUID and has
no name index). So this requires C_PlayerCache.SetEnabled(true)
to have been opted into; entries get there via the engine's
NAME_QUERY response hook, the visible-object scan, and
C_PlayerCache.RememberPlayer.
Implementation: O(1) lookup via a name → guid index map
maintained in lockstep with the GUID-keyed entry map. Eviction
keeps the index consistent: when a name's character is deleted and
the name is recycled to a different GUID, the prior entry is
removed from both maps.
C_PlayerCache.RememberPlayer(guid, name, classToken)
Adds a (guid → name, classID, raceID, sex) entry to the persistent
name cache. For the engine-driven coverage (chat / group / guild /
visible objects), no addon-side feeding is needed — those flow into
the cache automatically through the engine's
SMSG_NAME_QUERY_RESPONSE write path. This call exists for the
other sources libunitscan-style addons harvest from but the engine
NameCache doesn't see directly: /who results, mouseover, target
snapshots, etc.
C_PlayerCache.RememberPlayer(guid, name, classToken [, raceToken [, sex]])
Returns true on success, false if the persistent cache isn't
enabled or the required args are malformed.
guid—"0xHHHHHHHHLLLLLLLL"string (same formatUnitGUIDreturns). 8-hex"0xLLLLLLLL"is also accepted (hi-dword zero).name— 1–12 ASCII chars (vanilla character-name range). Tabs, newlines, and high bytes are stripped.classToken— uppercase token like"WARRIOR","MAGE". Looked up againstChrClasses.dbcfilename field, case-insensitive. Passing an unknown token keeps the entry's prior class (so a name-only sighting doesn't erase good class data).raceToken(optional) — uppercase token like"NIGHTELF","SCOURGE"(vanilla's filename for Undead). Same resolution as classToken, againstChrRaces.dbc. Omitted/unknown → leaves prior race alone.sex(optional) —0(male) or1(female), matching the wire-format convention the engine cache stores. Modern WoW'sUnitSexuses2/3; passUnitSex - 2if you're forwarding that value. Omitted/0→ leaves prior sex alone (so this call can't be used to flip a stored value back to male; theSMSG_NAME_QUERY_RESPONSEhook handles direct assignment).
-- Harvest /who results into the persistent cache
local function OnWhoUpdate()
for i = 1, GetNumWhoResults() do
local name, _, _, _, class, _, _, _, _, _, _, sex = GetWhoInfo(i)
-- class/race come back localized from GetWhoInfo; the
-- locale-token tables in pfUI/AceLocale handle the
-- inverse mapping. RememberPlayer expects engine tokens
-- ("WARRIOR" etc.).
end
end
Each non-zero field is updated on the existing entry; zeros are
treated as "caller doesn't know" and preserve prior real data. A
name-only update (classToken passed but unknown) refreshes the
name without erasing class.
The "deleted character recreated with same name, different class" collision case that name-keyed caches suffer from doesn't apply here: GUIDs are permanent for the life of a vanilla character, so the new character has a different GUID and gets a different cache entry.
C_PlayerInfo.GUIDIsPlayer(guid) / GUIDIsCreature / GUIDIsPet / GUIDIsGameObject
Type checks on the raw 1.12 GUID format. Vanilla GUIDs encode the
entity type in the high 16 bits of the qword — players have
0x0000 (low dword = player ID), creatures 0xF130xxxx, pets
0xF140xxxx, game objects (herbs / chests / etc.) 0xF110xxxx,
items 0x4000xxxx. Each function returns true only for its
specific prefix; the "0x0000000000000000" sentinel returns
false from all four.
if C_PlayerInfo.GUIDIsPlayer(UnitGUID("target")) then
-- target is a player
end
-- Combat-log row triage: was that a player kill or a mob kill?
local function OnCombatLogEvent(_, _, eventType, srcGUID, ...)
if eventType == "PARTY_KILL" then
if C_PlayerInfo.GUIDIsPlayer(srcGUID) then ... end
end
end
GUIDIsPlayer matches modern WoW's signature exactly; the other
three are companions for the most common type-distinction needs.
For other types (corpse, dynamic object, transport, item) the
underlying classifier exists internally — let us know if you need
one exposed.
Accepts either the 16-digit "0xHHHHHHHHLLLLLLLL" form or the
8-digit "0xLLLLLLLL" shortcut (high dword implicitly zero).
Malformed input returns false rather than raising — matching
modern's tolerance for stale GUIDs from addon-side caches.
C_CreatureInfo.GetCreatureID(guid)
Extracts the creature template / NPC ID from a unit GUID. Vanilla 1.12 packs the entry ID directly into bits 24-47 of the 64-bit GUID for the types that carry one; this function does the shift and mask so addons don't have to.
C_CreatureInfo.GetCreatureID(UnitGUID("target")) -- 1842 for Hogger
C_CreatureInfo.GetCreatureID(UnitGUID("pet")) -- pet's creature template ID
C_CreatureInfo.GetCreatureID(UnitGUID("player")) -- nil (no entry on players)
Accepts creature GUIDs (0xF130xxxx…) and pet GUIDs
(0xF140xxxx…). Returns nil for:
- non-string input or malformed GUIDs
- player GUIDs — the low 32 bits hold a player ID, not a template
- game-object / dynamic-object / corpse / item GUIDs — modern's
C_CreatureInfodoesn't surface entry IDs for these even though the bits are in the same range; addons that need them can shift the raw GUID themselves ((guid >> 24) & 0xFFFFFF) - entry IDs of 0 — the engine never assigns 0; treated as "no info"
The standard 16-digit ("0xHHHHHHHHLLLLLLLL") and 8-digit
("0xLLLLLLLL") GUID-string forms are both accepted, same as
C_PlayerInfo.GUIDIs* above.
C_PlayerCache.SetEnabled(enabled)
Opts into (or out of) the persistent name cache. enabled is a
boolean (numeric 0/1 also accepted). Persists to
WTF\Account\<account>\ClassicAPI.txt as
PersistentNameCacheEnabled=1/0, so the choice survives
client restarts.
When enabled:
- Every
SMSG_NAME_QUERY_RESPONSEthe engine processes is also written toWTF\Account\<account>\<realm>\ClassicAPI_NameCache.txt. - Lua-side
C_PlayerCache.RememberPlayercalls become effective (they're no-ops when the cache is disabled). GetPlayerInfoByGUIDgains the cross-session fallback path documented above.SetScanEnabledbecomes effective if also turned on.
When disabled, the on-disk file is left in place (re-enabling later restores the prior contents); future writes are simply suppressed.
C_PlayerCache.SetEnabled(true)
Returns nothing.
C_PlayerCache.IsEnabled()
Returns the current state of the persistent name cache as a
boolean. false until
SetEnabled
has been called (or its prior call survived in the on-disk settings
file).
if C_PlayerCache.IsEnabled() then
-- persistent fallback is active for GetPlayerInfoByGUID
end
C_PlayerCache.SetScanEnabled(enabled)
Opts into the visible-object sweep: an opportunistic walk of
the engine's live visible-object list that feeds every player in
render range (whose object is currently loaded by the client) into
the persistent name cache. Throttled to once per ~10 seconds, on
the existing Frame::RegisterEvent hook — no per-frame overhead,
no extra hooks installed.
enabled is a boolean (numeric 0/1 also accepted). Persists to
WTF\Account\<account>\ClassicAPI.txt as
NameCacheScanEnabled=1/0.
C_PlayerCache.SetEnabled(true) -- prerequisite
C_PlayerCache.SetScanEnabled(true)
-- Now: standing in Stormwind for a minute pre-populates the cache
-- with every visible player's name and class.
Independent of the cache toggle. Turning this on alone has no
effect — the sweep relies on Remember() which silently no-ops
when the on-disk cache is disabled. Turning the cache off (without
also turning the scan off) preserves the scan setting for the next
time you re-enable the cache.
Players only. NPCs and pets aren't cached — their GUIDs are ephemeral and can get reused across sessions, so caching them is worse than useless.
Implementation: walks ClntObjMgrEnumVisibleObjects
(0x00468380) — the same engine iterator
VanillaMinimapTracking
uses for blip rendering — filtering each GUID through
ClntObjMgrObjectPtr (0x00468460) with TYPEMASK_PLAYER. Name
comes from the CGObject vftable's GetName slot; class is the
byte at [m_objectFields + 0x79] (UNIT_FIELD_BYTES_0 byte 1, same
field Script_UnitClass reads).
C_PlayerCache.IsScanEnabled()
Returns the current visible-object scan setting as a boolean. Independent of the cache toggle — this only reflects the scan- specific setting, not whether the scan is effectively running (which also requires the cache to be on).
if C_PlayerCache.IsScanEnabled()
and C_PlayerCache.IsEnabled() then
-- visible-object sweeps are running every ~10s
end
Quest
C_QuestLog.GetQuestIDForLogIndex(index)
Returns the questID (Quest.dbc row ID) for the entry at the given 1-based
quest log index. In 3.3.5 this came as the 9th return of GetQuestLogTitle;
in 1.12 it isn't returned at all, even though the engine has it internally.
- Returns the questID for real quests.
- Returns
0for header rows (zone / category dividers). - Returns
nilif the index is out of range.
for i = 1, GetNumQuestLogEntries() do
local title, level, questTag, isHeader, isCollapsed, isComplete
= GetQuestLogTitle(i)
local questID = C_QuestLog.GetQuestIDForLogIndex(i) -- 0 for headers
-- ...
end
C_QuestLog.RequestLoadQuestByID(questID)
Asks the engine to fetch the static data for questID (title, description,
objectives, reward text) from the server if not already cached. Returns no
values — fire-and-forget, matching modern WoW's signature.
Fires QUEST_DATA_LOAD_RESULT(questID, success) when the data lands in the
cache. Synchronously fired when the data was already cached
(so polling code paths still work), asynchronously fired after
SMSG_QUEST_QUERY_RESPONSE lands when the engine had to round-trip to the
server.
Vanilla quirk: the engine has no native bool format code —
successarrives as1/0(number), nottrue/false, just likeITEM_DATA_LOAD_RESULT. Idiomatic check isif success == 1 then ....
Vanilla limitation: for invalid questIDs (ones the server doesn't have), the 1.12 server silently drops the query — it doesn't send a "not found" response packet. The engine's pending callback never resolves, so
QUEST_DATA_LOAD_RESULTdoesn't fire withsuccess=0either. Modern Classic Era servers explicitly respond with an error for invalid IDs, which is why modernRequestLoadQuestByIDreliably firessuccess=false; vanilla doesn't. Addons that need to handle "request timed out" should use their own timer (the Lua polyfill at!!!ClassicAPI/Util/QuestUtil.luauses a 180-second wait).
local f = CreateFrame("Frame")
f:RegisterEvent("QUEST_DATA_LOAD_RESULT")
f:SetScript("OnEvent", function()
-- vanilla 1.12: event payload is in `arg1`, `arg2`, ... globals
if event == "QUEST_DATA_LOAD_RESULT" and arg2 == 1 then
local questID = arg1
-- title/description/objectives are now in the engine's quest cache
end
end)
C_QuestLog.RequestLoadQuestByID(2)
C_QuestLog.IsOnQuest(questID)
Returns true if questID is currently in the player's quest log
(either still in progress or ready to turn in — both states live in
the log). Returns false for invalid input (non-positive, non-number,
or simply not in the log).
if C_QuestLog.IsOnQuest(215) then
-- player has "Jungle Secrets" accepted
end
Walks the same VAR_QUEST_LOG_ENTRIES array
C_QuestLog.GetQuestIDForLogIndex
reads and matches against each real entry's questID, skipping the
zone/category header rows.
Cheaper than the engine's IsUnitOnQuest(logIndex, unit), which
requires the addon to walk the log to find the matching index first
and resolves a unit token even when the answer is just about the
player. Same answer in a single call.
C_QuestLog.IsUnitOnQuest(unit, questID)
Returns true if the unit has questID in their quest list. Modern
arg order — unit first, questID second — and questID-keyed rather
than log-index-keyed like vanilla's IsUnitOnQuest(logIndex, unit).
if C_QuestLog.IsUnitOnQuest("party1", 215) then
-- partymate is also on Jungle Secrets
end
For unit == "player" equivalent to
C_QuestLog.IsOnQuest(questID). For
other tokens (party/raid members, target), the unit must be in the
engine's sync range — the data comes from SMSG_QUESTGIVER_QUEST_DETAILS
broadcasts, which only reach you while the other player is within
the client's sync window. Returns false for NPCs, units out of
range, and units that haven't synced their quest list yet.
Returns false (no lua_error) for invalid input: non-string unit,
non-number / non-positive questID, unresolvable token, or unit that's
not player-controlled (i.e., a creature). The
UNIT_FLAG_PLAYER_CONTROLLED gate is mandatory — without it the
+0xE68 deref would AV on any NPC.
C_QuestLog.GetTitleForQuestID(questID)
Returns the title (string) for questID from the engine's quest static-info
cache, or nil if the data isn't loaded. Doesn't require the quest to be
in the player's quest log — works for any questID once its data has been
fetched. Header rows are excluded (their titles live in QuestSort.dbc,
not in this cache); for those you'd use the existing GetQuestLogTitle.
The cache is populated lazily — by the engine's own quest-log path when
the player has the quest, or explicitly by
C_QuestLog.RequestLoadQuestByID. If the title isn't there yet, queue a
load and read on the event:
local f = CreateFrame("Frame")
f:RegisterEvent("QUEST_DATA_LOAD_RESULT")
f:SetScript("OnEvent", function()
if event == "QUEST_DATA_LOAD_RESULT" and arg2 == 1 then
local title = C_QuestLog.GetTitleForQuestID(arg1)
if title then
-- title is now available
end
end
end)
C_QuestLog.RequestLoadQuestByID(215)
C_QuestLog.IsQuestDataCachedByID(questID)
Returns true if the quest's static data is currently in the
client-side quest cache, false otherwise. Pure cache probe — no
server query, no side effects. Pair with
C_QuestLog.RequestLoadQuestByID when you need to ensure the data
is loaded before checking.
Returns false (not error) for invalid input — non-number,
non-positive, or non-existent questIDs all yield false, matching
the C_Item.IsItemDataCachedByID shape.
if not C_QuestLog.IsQuestDataCachedByID(questID) then
C_QuestLog.RequestLoadQuestByID(questID)
-- listen for QUEST_DATA_LOAD_RESULT, or re-check on a timer
end
GetQuestLogLeaderBoardID(objectiveIndex [, questIndex])
Companion to vanilla's GetQuestLogLeaderBoard — returns (id, kind)
for the same objective the existing call formats text for. id is
always positive (the raw RequiredNPCOrGo field is signed, but the
sign is folded into kind instead); kind is one of "monster",
"object", or "item". Returns nothing for: out-of-range
objectiveIndex, header rows, quests whose static data hasn't been
cached yet, or event-text-only objectives that have no entry ID.
Arg shape matches the engine's actual Script_GetQuestLogLeaderBoard
(its usage string says (index) but the function also accepts the
2-arg form): with questIndex provided, looks up the entry at
that 1-based quest-log slot; without it, falls back to whichever
quest is currently selected via SelectQuestLogEntry.
-- Selected quest path (pairs with GetQuestLogLeaderBoard's selected mode)
SelectQuestLogEntry(13)
local text, kind, done = GetQuestLogLeaderBoard(1)
local id = GetQuestLogLeaderBoardID(1)
-- text = "Young Stranglethorn Tiger slain: 4/10"
-- kind = "monster"
-- id = 2630 (the creature template / entry)
-- Explicit-quest path
local text, kind = GetQuestLogLeaderBoard(1, 13)
local id, k2 = GetQuestLogLeaderBoardID(1, 13)
-- kind == k2 always
The ID is the same key creaturecache.wdb / gameobjectcache.wdb /
itemcache.wdb use, so cross-referencing against the existing item
or creature caches is direct — no localized-text parsing required.
Why not just expose this on GetQuestLogLeaderBoard itself? Modifying
the engine's existing return tuple would silently break addons that
destructure positionally (local text, type, done = GetQuestLogLeaderBoard(...)).
A separate function keeps the existing call wire-compatible.
Source: the cached quest record (returned by
Quest::Cache::Peek) carries the SMSG_QUEST_QUERY_RESPONSE objective arrays inline at fixed offsets:
+0x149C—int32 RequiredNPCOrGo[4](positive = creature entry, negative = gameobject entry)+0x14AC—uint32 RequiredNPCOrGoCount[4]+0x14BC—uint32 RequiredItem[4]+0x14CC—uint32 RequiredItemCount[4]Iteration mirrors the engine at
0x004E0110: walk the NPC/GO array first, skip zero slots, then the item array. 1-basedobjectiveIndexcounts only non-empty slots.
Spell
All
C_Spell.*functions in this section accept any spell identifier, not just a numericspellID. The first argument can be:
- number — spellID, used directly.
|Hspell:N|hhyperlink — extracted by parsing for the embeddedspell:Npayload, soC_Spell.X(GetSpellLink(id))round-trips cleanly.- spell name — case-sensitive lookup through the engine's name resolver (
FUN_RESOLVE_SPELL_NAME_TO_BOOK_ID, the same chainCastSpellByNameuses). Tolerates(Rank N)suffixes via the engine's parser. Bounded to spells in the player's known spellbook — not arbitrary Spell.dbc rows.Unrecognized identifiers (garbage strings, nil, tables, etc.) return
nilrather than raising a Lua usage error — matches modern WoW's permissiveC_Spell.*convention. Function entries below write(spellID)in the signature for brevity but the broader shape is accepted everywhere.The legacy globals in this section (
GetSpellInfo,IsPassiveSpell,IsHarmfulSpell,IsUsableSpell, etc.) keep their existing(slot, bookType)overload — only theC_Spell.*namespace is broadened.
GetSpellInfo(spellID) / GetSpellInfo(slot, bookType)
Returns the same nine values as 3.3.5's GetSpellInfo, plus a 10th
value: spellID, for any spell ID — including spells the player
has not learned. Stock 1.12 has no GetSpellInfo Lua function at all
(only GetSpellName/GetSpellTexture, both of which take a spellbook
slot rather than an ID), so addons that need spell metadata for
arbitrary IDs (raid frames, debuff trackers, aura libraries) currently
can't get it.
Returns name, rank, icon, cost, isFunnel, powerType, castTime, minRange, maxRange, spellID. All read directly from Spell.dbc (with
SpellIcon.dbc, SpellCastTimes.dbc, and SpellRange.dbc for the
indirected fields). Cast time is in milliseconds; ranges are floats in
yards. isFunnel is a real boolean (true/false), matching 3.3.5's
behavior. Returns nil if the spell ID is out of range.
Two input forms are accepted:
GetSpellInfo(spellID)— direct DBC lookup by ID.GetSpellInfo(slot, bookType)— same shape as 1.12'sGetSpellName(slot, bookType).slotis 1-based,bookTypeis"spell"(player) or"pet". The slot is resolved to a spellID via the engine's spellbook array, then the same DBC reads run. Returnsnilfor empty / out-of-range slots.
local name, rank, icon, _, _, _, _, _, _, spellID = GetSpellInfo(133)
-- name="Fireball", rank="Rank 1", icon="Spell\\Fire\\...", spellID=133
-- spellbook overload
local _, _, _, _, _, _, _, _, _, id = GetSpellInfo(1, "spell")
-- id is the spellID at player spellbook slot 1
Note on the 10th return. Modern WoW (5.0+) added the spellID as the 14th return of its slimmer signature. We kept the existing 9 returns (so addons that worked against the previous signature still work) and just appended
spellIDat position 10.
C_Spell.GetSpellInfo(spellID)
Modern table-style accessor for the same data. Returns a Lua table of
the spell's metadata, or nil if the spell ID is out of range.
Table fields:
| Field | Type | Notes |
|---|---|---|
name |
string | Localized name |
iconID |
string | Icon path (e.g. "Interface\\Icons\\Spell_Fire_FlameBolt"). See note below. |
castTime |
number | Base cast time in milliseconds, or 0 for instant |
minRange |
number | Yards, or 0 if not applicable |
maxRange |
number | Yards, or 0 if not applicable |
spellID |
number | Echo of the input |
rank |
string | Localized rank (e.g. "Rank 1") — vanilla extra, not in modern's spec |
cost |
number | Base ManaCost — vanilla extra |
isFunnel |
boolean | True for funnel-channeled spells — vanilla extra |
powerType |
number | 0=mana, 1=rage, 2=focus, 3=energy, 4=happiness — vanilla extra |
local info = C_Spell.GetSpellInfo(133)
-- info.name = "Fireball"
-- info.iconID = "Interface\\Icons\\Spell_Fire_FlameBolt"
-- info.castTime = 1500
-- info.spellID = 133
-- info.rank = "Rank 1"
-- ... etc.
Deviation from modern. Modern WoW returns
iconIDas afileID:number. Vanilla 1.12 has no fileID system — assets are referenced by path strings. We surface the icon path here so it's directly usable withtexture:SetTexture(info.iconID). If you're backporting code that expects a number, this is the field to adjust.
Vanilla extras. The four fields beyond the modern spec (
rank/cost/isFunnel/powerType) are present because 1.12 has them inSpell.dbcand the previous-generationGetSpellInfoexposed them. Including them costs nothing and helps addons backporting from 3.3.5 where the same data was returned positionally.
C_Spell.GetSpellName(spellID)
Returns the localized name of spellID, or nil if the spell ID is out
of range or has no name in the current locale. Convenience accessor for
the name field of C_Spell.GetSpellInfo
when that's all you need — single field read, no DBC indirection beyond
the locale lookup.
local name = C_Spell.GetSpellName(133) -- "Fireball"
C_Spell.GetSpellTexture(spellID)
Returns the icon path string for spellID (read from SpellIcon.dbc
via the spell's SpellIconID field), or nil if the spell ID is out
of range or the icon record is empty.
Path string, not fileID. Modern WoW returns this as a
fileID:number. Vanilla 1.12 has no fileID system — see the same note onC_Spell.GetSpellInfo'siconIDfield. Pass directly totexture:SetTexture(...).
local path = C_Spell.GetSpellTexture(133)
-- path = "Interface\\Icons\\Spell_Fire_FlameBolt"
FindSpellBookSlotByID(spellID)
Inverse of 1.12's GetSpellName(slot, bookType). Given a spellID,
returns the 1-based slot it occupies in the player or pet spellbook,
along with the matching bookType so the result feeds directly into
slot-and-bookType APIs (GetSpellName, GetSpellTexture,
GameTooltip:SetSpell, etc.).
slot, bookType = FindSpellBookSlotByID(spellID)
- Returns
(slot, "spell")if the spell is in the player spellbook. - Returns
(slot, "pet")if it's only in the pet spellbook. - Returns
nilif the spellID isn't currently in either book.
Player book is searched first, so if a spell somehow appeared in both (unusual but possible for special pet-shared abilities), the player slot wins.
local slot, book = FindSpellBookSlotByID(133)
if slot then
GameTooltip:SetSpell(slot, book) -- shows full caster-scaled tooltip
end
Equivalent to the legacy function of the same name introduced in 3.0
(later renamed to FindSpellBookSlotBySpellID in 5.x).
GetSpellLink(spellID) / GetSpellLink(slot, bookType)
Returns the chat-style spell hyperlink and the spellID:
link, spellID = GetSpellLink(spellID)
= GetSpellLink(slot, bookType)
Format is |cff71d5ff|Hspell:ID:0|h[Name]|h|r — the standard 1.12
spell-link wrapper. The trailing :0 after the spellID matches modern
WoW's hyperlink shape (where the field is a sub-data slot for
pet-spellbook flags etc.); 1.12 ignores it during link parsing, but
addons grepping with |Hspell:(%d+): patterns will pick it up
correctly.
Two input forms, mirroring GetSpellInfo:
GetSpellLink(spellID)— direct DBC lookup.GetSpellLink(slot, bookType)— resolves the spellbook slot to a spellID first. Useful when iterating the player's known spells: caller gets back both the link AND the underlying ID without a separate lookup.
Returns nil if the spellID/slot doesn't resolve to a real spell.
local link = GetSpellLink(133)
DEFAULT_CHAT_FRAME:AddMessage("Cast " .. link .. "!")
-- Walking the spellbook to print every learned spell:
for slot = 1, 1000 do
local link, id = GetSpellLink(slot, "spell")
if not link then break end
-- ...
end
C_Spell.GetSpellLink(spellID)
Modern table-namespace variant. Same link string as
GetSpellLink(spellID),
but returns only the link — no spellID echo since the caller already
had it on hand to make the call.
local link = C_Spell.GetSpellLink(133) -- "|cff71d5ff|Hspell:133:0|h[Fireball]|h|r"
C_Spell.GetSpellDescription(spellID)
Returns the formatted spell description for any spellID — including
spells the player has not learned. $s1/$s2/$o1/$d-style
placeholders are resolved to base-rank values; ranges and durations
appear as actual numbers (e.g. "14 to 22 Fire damage", not
"$s1 to $s2 Fire damage"). Returns nil if the spell ID is out of
range or has no description in the current locale.
The 1.12 client doesn't expose this from Lua at all — the only existing
path is the scan-tooltip hack (set a hidden tooltip via
SetHyperlink("spell:"..ID) and read each TextLeftN:GetText() line).
That's slow, GC-heavy, and shares the global scan tooltip with every
other addon. This function calls the engine's own description formatter
directly — same code path the in-game tooltip uses, no UI side effects.
local desc = C_Spell.GetSpellDescription(133) -- Fireball Rank 1
-- "Hurls a fiery ball that causes 14 to 22 Fire damage and an additional
-- 2 Fire damage over 4 sec."
No caster scaling. Values reflect the spell's base rank — caster level / spell power / talents are not applied. Modern WoW behaves the same way when called outside a unit context. If you need the "currently displayed" tooltip text with caster scaling, use
GameTooltip:SetSpellByIDand read line strings from there.
C_Spell.GetSpellReagents(spellID)
Returns the spell's reagent list as an array of
{ itemID = N, count = M } tables, one entry per non-empty reagent
slot. Returns an empty array {} for spells that consume no
reagents, or nil for invalid spell IDs.
local list = C_Spell.GetSpellReagents(23028) -- Arcane Brilliance
-- list = { { itemID = 17020, count = 1 } } -- 1× Arcane Powder
-- Crafting recipe:
local list = C_Spell.GetSpellReagents(2538)
-- Cooking-style: { { itemID = ..., count = ... }, ... }
Reads directly from Spell.dbc at the documented reagent offsets
(+0xA8 for itemIDs, +0xC8 for counts — verified empirically
from the engine's tooltip-builder; the CMaNGOS-style schema
documented in some emulator sources places these at +0x110 /
+0x130, which is wrong for 1.12.1). Iteration stops at the first
empty slot, matching how the engine walks its own reagent loop.
IsPassiveSpell(spellID) / IsPassiveSpell(slot, bookType)
Returns true if the spell is passive (no cast bar — applies its effect
as soon as it's learned/equipped), false otherwise. Returns nil for
invalid spell IDs / out-of-range slots.
Reads Attributes bit 6 (SPELL_ATTR_PASSIVE = 0x40) directly off the
Spell.dbc record. Used by aura libraries and talent code to decide
whether a spell needs cast-bar tracking.
IsPassiveSpell(6603) -- true (Auto Attack)
IsPassiveSpell(133) -- false (Fireball)
-- spellbook overload mirrors GetSpellInfo's
IsPassiveSpell(1, "spell") -- true/false depending on slot 1
C_Spell.IsSpellPassive(spellID)
Modern table-namespace form of IsPassiveSpell.
Same return semantics; doesn't accept the legacy
(slot, bookType) shape.
C_Spell.IsSpellPassive(6603) -- true (Auto Attack)
IsPlayerSpell(spellID)
Returns true if the player currently knows the given spellID, false
otherwise. Covers everything granted by SMSG_LEARNED_SPELL:
- Trained class abilities (the obvious case)
- Racial abilities
- Talent passives the player has invested in
- Profession recipes — including ones from vendors / discovered via tradeskill — without needing to have the trade skill window open
- Anything else the engine considers "known"
IsPlayerSpell(133) -- true if you have Fireball
IsPlayerSpell(2963) -- true for a tailor who knows Bolt of Linen
-- (works without opening the Tailoring window)
Only the current rank counts. For ranked spells (passives, trained ranks), only the spellID of the player's current rank returns
true— lower-rank IDs returnfalseeven though the player conceptually "has" them. Matches the same semantic Classic Era 1.15.x uses: a player with 5/5 Unbreakable Will seesIsPlayerSpell(14791)(rank 5) as true but rank 4 / rank 3 / etc. as false.This is by design — the engine's spell-knowledge bitmap stores one bit per spellID, and the highest-rank spellID is the one set when you train up. To check "do I have at least rank N", use the rank-N spellID specifically.
Reads a single bit from the engine's spell-knowledge bitmap at
[0x00B710FC] — (bitmap[spellID >> 5] & (1 << (spellID & 31))) != 0.
The same lookup the engine itself does internally. No spellbook walk,
no talent walk, no profession-window dependency.
IsSpellKnown(spellID, [isPet])
Returns true if the given spellID is currently in the player's (or
pet's) spellbook arrays — the same source the in-game spellbook UI
displays. Strict semantics: only counts spells that have a
spellbook button. isPet defaults to false.
IsSpellKnown(2050) -- true if Lesser Heal is trained
IsSpellKnown(2649, true) -- true if your hunter pet has Growl
IsSpellKnown(133) -- false on a Priest (Fireball is a Mage spell)
Not the same as
IsPlayerSpell. Modern WoW deliberately splits these two:IsSpellKnownis the strict "in the spellbook UI" check,IsPlayerSpellis the broad "any kind of known" query. The split matters because:
Spell type IsPlayerSpellIsSpellKnownTrained class ability (Fireball) truetrueActive talent grant (Mortal Strike) truetruePassive talent (Wand Spec, Imp Fireball) truefalseProfession recipe (Bolt of Linen) truefalseUse
IsPlayerSpellfor "do I have access to this effect at all"; useIsSpellKnownfor "is this in my spellbook so I can put it on an action bar".
Implementation walks VAR_PLAYER_SPELLBOOK (0x00B700F0) when
isPet=false or VAR_PET_SPELLBOOK (0x00B6F098) when isPet=true.
Verified to match 3.3.5's Script_IsSpellKnown semantics — that
function does the same spellbook walk in its inner helper at
0x0053B4E0 (player array [0x00BE6D88], pet array [0x00BE7D98],
same shape just different addresses).
IsUsableSpell(spell) / IsUsableSpell(slot, bookType)
Returns (usable, noMana) for a spell, matching the modern
3.0+ signature. Returns (1, nil) when the spell is castable,
(nil, 1) when only mana is preventing it, (nil, nil) for any
other reason (unknown spell, dead, etc.). Matches the 1/nil
return convention of the existing Script_IsUsableAction.
Two arg shapes accepted:
IsUsableSpell(spellID)— direct spellID lookup.IsUsableSpell(slot, bookType)—bookTypeis"spell"(player) or"pet". Resolves to a spellID via the same engine spellbook arraysGetSpellInfo/GetSpellLinkwalk.
IsUsableSpell(133) -- Fireball: 1, nil if you have mana, nil, 1 if not
IsUsableSpell(1, "spell") -- player spellbook slot 1
What this function checks:
- Player knows the spell (engine's spell-knowledge bitmap — covers trained class abilities, talent passives, racials, profession recipes).
- Player is alive (HEALTH > 0).
- Spell is not on cooldown (engine's per-spell cooldown helper).
- Player has enough of the spell's power type for the base cost (mana / rage / focus / energy / happiness) — only this failure sets
noMana=true.- Player has all required reagents in bags (Spell.dbc Reagent[8] / ReagentCount[8]).
What this function doesn't check (different concerns or post-vanilla concepts): silence, GCD, stance/form, range, target type, line-of-sight, casting state.
Verified empirically on Turtle WoW for the mana branch: Renew rank 3 (cost 105) is reported usable at 144 mana and unusable at 39 mana, transitioning at exactly the cost boundary. Cooldown and reagent checks ship in the same implementation but haven't been exercised in-game; if you find an inconsistency, the reagent offsets (+0x110 / +0x130) and cooldown helper (
0x006E2EA0) are the components to verify.
C_Spell.IsSpellUsable(spellID)
Modern table-namespace form. Same logic as
IsUsableSpell(spellID)
but returns proper booleans (isUsable, insufficientPower) per
the C_Spell.* convention rather than 1/nil pairs.
local usable, noMana = C_Spell.IsSpellUsable(133)
-- usable=true, noMana=false → cast it
-- usable=false, noMana=true → drink up
-- usable=false, noMana=false → unknown spell, dead, or other block
C_Spell.GetSpellCooldown(spellIdentifier)
Returns a SpellCooldownInfo table for the given spell, or nil if
the identifier doesn't resolve to a Spell.dbc row. Modern
table-shape variant of vanilla's GetSpellCooldown(slot, bookType) —
accepts a spellID directly without forcing the caller to resolve a
spellbook slot first.
local info = C_Spell.GetSpellCooldown(1953) -- Blink
-- on cooldown: { startTime=728565.79, duration=15, isEnabled=true, modRate=1 }
-- off cooldown: { startTime=0, duration=0, isEnabled=true, modRate=1 }
| Field | Type | Notes |
|---|---|---|
startTime |
number | Engine tick count (seconds) when the cooldown began. Same epoch as GetTime(), so info.startTime + info.duration is the absolute time the cooldown ends. 0 when no cooldown active. |
duration |
number | Cooldown length in seconds; 0 when no cooldown active. |
isEnabled |
boolean | false when the cooldown is "on hold" (e.g. some channeled abilities). true for normal cooldowns. |
modRate |
number | Always 1.0 — vanilla has no haste-on-cooldown mechanic. |
Modern-only fields (activeCategory, timeUntilEndOfStartRecovery,
isOnGCD) read as nil since they have no vanilla source.
Returns nil if the resolved spellID is 0 or doesn't have a
Spell.dbc row.
C_Spell.IsCurrentSpell(spellIdentifier)
Returns true if the spell is currently being cast, queued mid-GCD,
or channeled by the player; false otherwise (including for
unresolvable identifiers).
C_Spell.IsCurrentSpell(11366) -- true while casting Pyroblast
C_Spell.IsCurrentSpell("Pyroblast") -- same, via name
C_Spell.IsCurrentSpell(GetSpellLink(7620)) -- true while channeling Fishing
Useful for action-bar addons that want to highlight the active / queued button — modern action bars gate the "currently casting" glow on this. Reads three engine slots and returns true on any match:
VAR_CURRENT_CAST_SPELL(0x00CECA88) — cast-bar spellID. Written byFUN_006E4AD0when a new cast begins; cleared on cast end.VAR_QUEUED_CAST_SPELL(0x00CECAA8) — spell that was active when a new cast superseded it mid-GCD. Restored to current when the new cast ends, so checking it here covers the "queued to cast next" half of modern's documented semantics.UNIT_FIELD_CHANNEL_SPELL(descriptor+0x228) on the player — covers channeled abilities (Fishing, Drain Soul, Ritual of Summoning, etc.).
C_Item.GetWeaponEnchantInfo()
Returns the modern 12-tuple matching WotLK+'s extended
GetWeaponEnchantInfo signature, including the temp-enchant IDs
that vanilla 1.12's 8-return global omits.
hasMain, mainExpire, mainCharges, mainEnchantID,
hasOff, offExpire, offCharges, offEnchantID,
hasRanged, rangedExpire, rangedCharges, rangedEnchantID
= C_Item.GetWeaponEnchantInfo()
-- Apply Brilliant Mana Oil to mainhand, then:
local has, expireMs, charges, enchantID = C_Item.GetWeaponEnchantInfo()
-- has = true, expireMs ≈ 1800000, charges = 5, enchantID = <oil's enchant>
Reads the temporary enchant slot (ITEM_FIELD_ENCHANTMENT
slot 1 at descriptor +0x4C) — the same slot oils, sharpening
stones, and poisons populate and the engine drains as they expire.
This is what modern's GetWeaponEnchantInfo measures.
The permanent enchant (Crusader, Mongoose, etc., in slot 0 at
+0x40) is not reported here — that's a separate field and
modern's GetWeaponEnchantInfo doesn't expose it either. Get the
permanent enchant ID by parsing GetInventoryItemLink("player", slot) (the link includes it as the 2nd numeric field).
Vanilla 1.12's global GetWeaponEnchantInfo is unchanged — old
addons reading positions 4..8 by index still work.
Equivalent to the extension of GetWeaponEnchantInfo introduced
in 3.x.
IsHarmfulSpell(spell) / IsHelpfulSpell(spell)
Classify a spell as offensive (IsHarmfulSpell) or non-offensive
(IsHelpfulSpell) without parsing its tooltip. Accept either form
the spellbook-aware globals use:
IsHarmfulSpell(spellID) -- by ID
IsHarmfulSpell(slot, "spell") -- player spellbook slot
IsHarmfulSpell(slot, "pet") -- pet spellbook slot
-- same calling shapes for IsHelpfulSpell
Examples:
IsHarmfulSpell(133) -- true (Fireball)
IsHarmfulSpell(118) -- true (Polymorph)
IsHelpfulSpell(2061) -- true (Flash Heal)
IsHelpfulSpell(1243) -- true (Power Word: Fortitude)
IsHarmfulSpell(2061) -- false
Reads Spell.dbc.AttributesEx (record +0x1C) bit 0x80 — the
same SPELL_ATTR_EX_NEGATIVE bit CMaNGOS uses to mark spells as
debuffs server-side. IsHarmfulSpell is true iff that bit is set;
IsHelpfulSpell is true iff the spell exists and the bit is NOT
set. Both return false for invalid spellIDs.
Vanilla 1.12 doesn't have a dedicated "positive" flag, so the helpful side is the rough complement of harmful. For utility spells with no clear orientation (Aspect of the Cheetah, Stealth, ground-targeted AOEs), modern WoW sometimes returns false for both; we return
truefor helpful as a safer default for addons gating on "is this castable on me?" logic. Compute precise modern semantics by also inspecting effect implicit targets if you need them.
C_Spell.IsSpellHarmful(spellID) / C_Spell.IsSpellHelpful(spellID)
Same classification logic as the globals above, exposed in the modern
C_Spell namespace. Don't accept the legacy (slot, bookType)
shape.
C_Spell.IsSpellHarmful(133) -- true (Fireball)
C_Spell.IsSpellHelpful(2061) -- true (Flash Heal)
Equivalent to C_Spell.IsSpellHarmful / C_Spell.IsSpellHelpful
introduced in 11.x.
C_SpellBook.GetSpellLevelLearned(spellID)
Returns the level at which a spell becomes available — the
BaseLevel field in Spell.dbc (record +0x70). Direct read off
the cached record; no class/race filtering.
C_SpellBook.GetSpellLevelLearned(133) -- Fireball rank 1 → 4
C_SpellBook.GetSpellLevelLearned(25306) -- Fireball rank 12 → 60
C_SpellBook.GetSpellLevelLearned(2061) -- Flash Heal rank 1 → 20
Returns 0 for invalid spellIDs, spells with no level requirement
(most non-class utility spells), or records the engine hasn't
cached. Matches modern semantics — unknown / utility spells
return 0 rather than nil.
C_SpellBook.GetCurrentLevelSpells([level])
Returns a 1-based table of spellIDs the player's class/race can learn at the given level. Without arguments, defaults to the player's current level.
C_SpellBook.GetCurrentLevelSpells() -- spells trainable at your level
C_SpellBook.GetCurrentLevelSpells(20) -- preview what's available at 20
C_SpellBook.GetCurrentLevelSpells(60) -- preview at 60
Walks SkillLineAbility.dbc filtering by the player's class bit
(1 << (classID - 1)) and race bit, respecting both the include
masks (entries with mask = 0 are "all classes"/"all races", which
also pass) and the exclude masks. For each surviving entry, looks
up the spell's BaseLevel and includes it if it matches the
queried level.
Vanilla is trainer-driven. Modern
GetCurrentLevelSpells(added in 5.x when trainers were removed) returns auto-learned spells. Vanilla 1.12 requires visiting a trainer to actually learn most class spells. We return the closest available analog: what's trainable at this level. Useful for "what's new this level" UI panels and level-preview tooling ported from MoP+.
Class/race come from the local player — there's no
(class, race, level) form because vanilla doesn't expose a
clean class-string→classID lookup. Returns an empty table at
character select / pre-login (no CGPlayer yet) and for levels
where no class/race spells match.
C_SpellBook.GetSpellSkillLine(spellID)
Returns (name, skillID) — the SkillLine.dbc row that the given spell
belongs to. The name is the user-facing skill/tab string in the engine's
current locale: spellbook tab names for class spells ("Protection",
"Fire", "Holy"), profession headers ("Tailoring", "Engineering"),
weapon-skill rows ("Swords", "Bows"), etc.
C_SpellBook.GetSpellSkillLine(1671) -- "Protection", 26 (Shield Bash)
C_SpellBook.GetSpellSkillLine(133) -- "Fire", 8 (Fireball)
C_SpellBook.GetSpellSkillLine(2050) -- "Holy", 56 (Lesser Heal)
C_SpellBook.GetSpellSkillLine(2480) -- "Bows", 45 (Shoot Bow)
C_SpellBook.GetSpellSkillLine(3273) -- "First Aid", 129 (Anesthetic)
Walks SkillLineAbility.dbc for any row whose spellID matches, then
reads the localized Name[locale] field at offset +0x0C of the
referenced SkillLine.dbc record. For spells with multiple SLA rows
(race-locked variants, Turtle WoW's faction-specific entries) the
lookup prefers a row whose class/race masks match the local player —
so the result reflects "what tab is this spell in for me" when one
exists. Falls back to the first matching row otherwise, so the
function still answers for spells the local player can't actually use
(inspecting other classes, parsing combat-log entries from unfamiliar
specs).
Returns (nil, nil) for:
- non-numeric or non-positive input
- spellIDs with no
SkillLineAbility.dbcrow (most temporary auras, proc-only spells, item-on-use effects, GM-debug spells) - rows whose
skillIDdoesn't resolve inSkillLine.dbc
Vanilla's GetSpellTabInfo(tabIndex) enumerates spellbook tabs by
1-based index — it can't answer "what tab is this spellID in".
Addons that need a spellID→tab mapping have historically had to walk
every tab's slot range and string-match against GetSpellName. This
function reads it directly off the DBC for any spellID, including
spells the player hasn't learned.
GetSpellSchool(spellID)
Returns (schoolID, schoolName) for any spell — known to the player
or not. schoolID is 1-based; schoolName is the locale-independent
English name.
| schoolID | schoolName |
|---|---|
| 1 | "Physical" |
| 2 | "Holy" |
| 3 | "Fire" |
| 4 | "Nature" |
| 5 | "Frost" |
| 6 | "Shadow" |
| 7 | "Arcane" |
Reads directly from Spell.dbc record +0x04. Vanilla 1.12 stores
School as a single 0-based integer (no multi-school SchoolMask
combinations — that's a TBC+ thing), so a spell belongs to exactly
one school.
Returns nil for invalid spellIDs (out of range or unpopulated
Spell.dbc slot).
local id, name = GetSpellSchool(133) -- 3, "Fire" (Fireball)
local id, name = GetSpellSchool(116) -- 5, "Frost" (Frostbolt)
local id, name = GetSpellSchool(635) -- 2, "Holy" (Holy Light)
Useful for combat-log breakdown addons, dispel-eligibility checks,
resistance-aware aura libraries, and damage-meter school tagging.
Previously addons either maintained hardcoded spellID → school
tables or scanned tooltips for the first-line color tag.
CastSpellNoToggle(name | spellID)
Spam-safe variant of CastSpellByName that won't toggle off an
already-active spell. Covers both kinds of vanilla-toggle abilities:
- Auto-repeat — Shoot, Auto-Shot, Wand. Tracked via the engine's active-auto-repeat global.
- Self-aura toggles — shapeshift (Cat/Bear/Travel/Moonkin/ Shadowform), stance (Battle/Defensive/Berserker), aspect (Hunter), seal (Paladin), blessing-on-self, etc. Tracked via the unit descriptor's aura array.
If either toggle is already on for the requested spell, the call is
a no-op — exactly what /cast !SpellName does in 2.3.2+ clients,
but expressed as a vanilla Lua call.
| Engine state | Behavior | Return |
|---|---|---|
| Nothing toggled | Starts the cast | true if the spell is now active, else false |
| This spell already auto-repeating | No-op | true |
| This spell's aura already on (form / stance / aspect) | No-op | true |
| A different auto-repeat is active | No-op | false (don't disrupt the other auto-repeat) |
Replaces both the action-bar scan-and-skip pattern and the form-already-active check:
-- Before (auto-repeat case)
for i = 1, 120 do
if IsAutoRepeatAction(i) then return end
end
CastSpellByName("Shoot")
-- Before (shapeshift case)
if not (UnitBuff("player", "Cat Form") or GetShapeshiftFormID() == CAT_FORM) then
CastSpellByName("Cat Form")
end
-- After (both cases)
CastSpellNoToggle("Shoot")
CastSpellNoToggle("Cat Form")
Accepts either a name string or a spellID number:
CastSpellNoToggle("Shoot") -- by name (matches what CastSpellByName accepts)
CastSpellNoToggle(75) -- by spellID (Auto Shot rank 1)
CastSpellNoToggle("Aspect of the Hawk")
CastSpellNoToggle("Battle Stance")
String input matches case-insensitively and tolerates a trailing
(Rank N) suffix the same way CastSpellByName itself does —
"Shoot" and "Shoot(Rank 1)" both compare equal to a Shoot that's
already auto-repeating.
Reads [VAR_ACTIVE_AUTO_REPEAT_SPELL] (0x00CEAC30) for the auto-
repeat check, and the engine's FUN_SPELL_IS_TOGGLE_AURA_ACTIVE
(0x004B36F0) for the aura-active check. Delegates to
Script_CastSpellByName (0x004B4AB0) for the actual cast — same
resolution semantics (rank picking, target rules, etc.) as the
engine's own global.
Using this from inside a macro action slot? See
CastSpellNoToggle as a macro cast line below for the additional
parser support that makes the slot tag correctly for action-bar UIs.
C_Spell.CancelSpellByID(spellID) / CancelSpellByName(name)
Cancel a buff on the player by spellID or by spell name. Modern WoW's
CancelUnitBuff reduces to these two primitives internally; both are
player-only (vanilla server only accepts CMSG_CANCEL_AURA for the
local player's own auras).
C_Spell.CancelSpellByID(2378) -- Cancel "Find Herbs"
CancelSpellByName("Cat Form") -- Drop shapeshift
| Function | Arg | Behavior |
|---|---|---|
C_Spell.CancelSpellByID(spellID) |
spellID (number) | Sends CMSG_CANCEL_AURA for spellID directly. No client-side check that the buff is actually present — server validates and silently no-ops if not. |
CancelSpellByName(name) |
name (string, case-insensitive) | Walks the player's buff range (UnitBuff slots 0..31) for the first aura whose Spell.dbc localized name matches, then cancels by its spellID. Buff-only — debuffs are skipped. |
Calls FUN_006E7040 (0x006E7040) directly with the spellID. This
bypasses Script_CancelPlayerBuff's client-side gates — the
per-buff cancelable flag at [entry+0x0A] & 0x01 and the fallback
AttributesEx & 0x04 check on the spell record. Trade-off: the server
is now the sole authority on what's cancelable. Non-cancelable auras
(proc-buffs, certain world buffs) still get rejected — just server-side
instead of client-side, which is the same effective behavior as
modern WoW's C_Spell.CancelSpellByID.
For invalid input (non-positive spellID, OOR, or a Spell.dbc empty
slot), both functions silently no-op. No lua_error, no event fired.
Spell name matching is case-insensitive via _stricmp. Rank-suffixed
input (e.g. "Power Word: Fortitude(Rank 4)") is not parsed —
pass the plain name. Multi-rank buffs match on first-found; if you
have multiple ranks of the same buff active (unusual but possible with
e.g. paladin blessings before talent merge), the first slot wins.
State
Player movement / visibility state queries that modern WoW exposes as no-arg globals. 1.12 doesn't bind them to Lua despite the engine tracking the underlying state — broadcast in UpdateFields for some (mount, stealth visibility), local-only for others (falling, swimming).
IsMounted()
Returns true if the player is currently mounted, false otherwise.
Reads UNIT_FIELD_MOUNTDISPLAYID from the player's broadcast
descriptor. The field holds a creature display ID (the model the
engine renders under the player) when mounted, and 0 otherwise.
if not IsMounted() then
CastSpellByName("Summon Dreadsteed")
end
Dismount()
Dismisses the player's currently summoned mount. No-op when the player isn't mounted.
if IsMounted() then Dismount() end
Walks the player's buff range for an aura whose Spell.dbc effects
include SPELL_AURA_MOUNTED (78), then sends CMSG_CANCEL_AURA for
that spellID via the same direct sender C_Spell.CancelSpellByID uses. By the
time the server processes the cancel, IsMounted() will return
false.
IsStealthed()
Returns true if the player is currently in Stealth (Rogue) or
Prowl (Druid), false otherwise.
Reads bit 0x02 of the player visibility byte at descriptor
+0x17C and AND-gates with MountDisplayID == 0 to disambiguate
mount (which sets the same bit). Untested for Druid shapeshift
forms — if you find a false-positive there, file an issue and we'll
switch to walking the player's aura array for the actual stealth
spell.
if IsStealthed() then
-- defer the spell that would break stealth
end
IsFalling()
Returns true if the player is currently mid-jump or falling,
false otherwise.
Reads the local CGPlayer movement-flags word at +0x9E8 and tests
MOVEFLAG_FALLING | MOVEFLAG_FALLING_FAR (0x2000 | 0x4000). This
is client-side state (outbound MSG_MOVE_* data, never visible for
remote units), so the function only meaningfully applies to the
local player.
if not IsFalling() then
-- safe to bind ground-targeted spell
end
IsSwimming()
Returns true if the player is currently swimming (in liquid, with
the swim animation/movement set), false otherwise.
Same movement-flags word as IsFalling, testing MOVEFLAG_SWIMMING
(0x200000). Local-player only.
if IsSwimming() then
-- breath bar logic, mount-failure suppression, etc.
end
IsAssistingRitual()
Returns true if the local player is currently clicking a warlock
summoning portal (the channel-on-GameObject state with no castbar
UI, where movement breaks the channel), false otherwise.
This is distinct from spell channeling: the function fires for
participants who clicked the portal, not the warlock who cast
Ritual of Summoning. Vanilla has no Lua surface for this state —
the engine's SPELLCAST_CHANNEL_* events don't fire and
CastingInfo() returns nothing — so addons that want to react to
the player being committed to a ritual (e.g. suppress autorun
toggles, hide nameplate clicks, warn before movement) have no other
way to detect it.
Detection uses two state slots:
UNIT_CHANNEL_SPELL(descriptor+0x228) — the warlock's channel spell ID (698) is mirrored onto every clicker for the duration of the ritual.- A CGPlayer-local pointer at
+0xB4— the engine's "current spell cast target GameObject" slot, set to the portal GO while the clicker is engaged.
Either signal alone is ambiguous (the warlock channeling matches the first; mining and other GO-targeted casts match the second); the conjunction is portal-clicker-specific.
The engine fires SPELLCAST_CHANNEL_START / SPELLCAST_CHANNEL_STOP
on the portal click, even though there's no castbar — Blizzard's
vanilla castbar UI filters out spell ID 698 (Ritual of Summoning),
but the events themselves fire normally. Combine them with this
function for ritual-specific triggers:
local frame = CreateFrame("Frame")
frame:RegisterEvent("SPELLCAST_CHANNEL_START")
frame:RegisterEvent("SPELLCAST_CHANNEL_STOP")
frame:SetScript("OnEvent", function()
if event == "SPELLCAST_CHANNEL_START" and IsAssistingRitual() then
-- player just committed to a ritual portal
elseif event == "SPELLCAST_CHANNEL_STOP" then
-- channel ended; was it a ritual?
end
end)
Local-player only — the +0xB4 pointer lives on the CGPlayer
object, not in the broadcast descriptor, so the function can't
report state for target / party* / etc. Returns false when
called before the player object is initialized (login screen).
GetMirrorTimerInfo(index) / GetMirrorTimerProgress(label)
Modern (3.0+) readers for the BREATH (drowning) / EXHAUSTION
(off-map) / FEIGNDEATH (hunter Feign Death) bar state. The vanilla
engine fires the MIRROR_TIMER_START / _PAUSE / _STOP events
with the full packet payload but doesn't cache anything internally;
ClassicAPI hooks the SMSG handler at 0x005E7990 and builds a
3-slot side cache so these accessors work.
GetMirrorTimerInfo(index) — index is 1, 2, or 3 (slot id). Returns
(timer, value, maxValue, scale, paused, label) for an active slot,
or nothing if that slot is empty:
| Return | Type | Meaning |
|---|---|---|
timer |
string | Engine type-name: "EXHAUSTION", "BREATH", or "FEIGNDEATH" |
value |
number | The snapshot value from the last server packet (ms). Not live-interpolated — see GetMirrorTimerProgress for that |
maxValue |
number | Timer's max (ms) |
scale |
number | Server-set rate. Negative = depleting (vanilla sends -1 for breath, draining 60000 ms over 60 s of real time); positive = filling. Modern's docs describe the opposite convention — vanilla's wire format predates that flip |
paused |
boolean | true if the engine has frozen the timer |
label |
string | Localized display label, e.g. "Breath". For FEIGNDEATH, the spell name |
GetMirrorTimerProgress(label) — label is the engine type-name
("BREATH" etc.). Returns the live interpolated value in
milliseconds, computed each call from the snapshot + elapsed
real-time ticks. Returns 0 when no matching timer is active.
local f = CreateFrame("Frame")
f:RegisterEvent("MIRROR_TIMER_START")
f:SetScript("OnEvent", function()
-- pull whichever slot the engine just populated
for i = 1, 3 do
local timer, value, maxv, scale, paused, label = GetMirrorTimerInfo(i)
if timer then
DEFAULT_CHAT_FRAME:AddMessage(format("%s: %d / %d (%s)",
label, value, maxv, paused and "paused" or "running"))
end
end
end)
-- Smooth bar updates: poll progress in OnUpdate
local function OnUpdate(self)
self:SetValue(GetMirrorTimerProgress("BREATH"))
end
Modern uses
"FATIGUE", vanilla uses"EXHAUSTION". The engine type-name string for the off-map timer is"EXHAUSTION"in 1.12 — we surface what the engine actually returns rather than translating to modern's name. Addons backporting"FATIGUE"-keyed code need to handle either string.
GetShapeshiftFormID()
Returns the player's current shapeshift form as the integer ID from
vanilla 1.12.1's SpellShapeshiftForm.dbc. Returns 0 when the
player isn't shifted.
| Class | Form IDs |
|---|---|
| Druid | 1 Cat, 2 Tree, 3 Travel, 4 Aquatic, 5 Bear, 8 Dire Bear, 31 Moonkin |
| Warrior | 17 Battle, 18 Defensive, 19 Berserker |
| Shaman | 16 Ghost Wolf |
| Rogue | 30 Stealth |
| Priest | 28 Shadowform, 32 Spirit of Redemption |
Turtle WoW extends the DBC with custom rows that aren't present on Blizzard 1.12.1:
| ID | Name | Notes |
|---|---|---|
9 |
Tree of Life Form | Restoration druid endgame form |
11 |
Swift Travel Form | Mounted-speed travel form |
Vanilla numbering ≠ modern numbering. Modern WoW renumbered the table — e.g. modern uses
17for Travel and35for Tree of Life, where 1.12.1 uses3(Travel) and Turtle uses9(Tree of Life). Don't copy named constants from a modern addon and expect them to match.
if GetShapeshiftFormID() == 0 then
CastSpellByName("Cat Form")
end
Reads byte 2 of UNIT_BYTES_1 (descriptor +0x212) on the local
player — the same byte vanilla's Script_GetShapeshiftFormInfo
compares against each form-spell's effect-encoded form ID to answer
"is this form active". The engine updates the byte from
SMSG_UPDATE_OBJECT aura/form packets, so the value is live without
needing an event listener.
Vanilla 1.12 has only GetShapeshiftFormInfo(index) (1-based bar
index); GetShapeshiftFormID exposes the DBC ID directly so callers
can write if formID == CAT_FORM without iterating the bar.
CancelShapeshiftForm()
Cancels the player's current shapeshift form, dropping them back to caster (or whatever neutral state the class uses). No-op when the player isn't shifted.
if GetShapeshiftFormID() ~= 0 then
CancelShapeshiftForm()
end
Covers druid forms (Cat / Bear / Travel / Aquatic / Moonkin / Dire
Bear / Tree of Life), shaman Ghost Wolf, priest Shadowform / Spirit of
Redemption, and rogue Stealth. No form table hardcoding — the
implementation finds whichever buff currently provides the active form
by scanning Spell.dbc effects.
Does not cover warrior stances. Vanilla treats warriors as always in a stance — the engine has no "no stance" state and right-clicking the active stance in the stance bar does nothing. The server rejects the cancel packet for stances, so this function is a no-op when called as a warrior. Switch stances with the normal stance spells instead.
Implementation: reads the current form byte (descriptor +0x212,
same source as GetShapeshiftFormID()), walks
the player's buff slots (0..31), looks up each spell's
Spell.dbc[spellID] effect arrays, and on the first effect whose
EffectApplyAuraName is SPELL_AURA_MOD_SHAPESHIFT (36) and whose
EffectMiscValue matches the current form ID, sends CMSG_CANCEL_AURA
via the engine's direct sender at FUN_006E7040.
Mirrors 3.3.5a's Script_CancelShapeshiftForm inner (FUN_00726CE0),
which does the same effect-array scan + form-id match before issuing
its cancel packet. Vanilla just lacks the public Lua surface.
Table
table.wipe(t)
Removes every key from t, leaving it empty but preserving its
internal hash and array capacity. Returns t for chaining.
local cache = {}
-- ... fill it up ...
table.wipe(cache) -- cache is now {}
local also_t = table.wipe(t2) -- also_t === t2 after wipe
Port of Blizzard's 3.3.5 implementation at VA 0x00852180 — same
pattern, just using 1.12's Lua 5.0 entry points instead of 5.1's.
Both Lua versions' lua_next walks the hash node array linearly,
so the canonical lua_next + rawset(k, nil) "during-iteration
removal" pattern works in practice even though it's technically
undefined per the Lua reference manual.
Errors on non-table input.
Talent
GetTalentSpellID(tabIndex, talentIndex, [rank])
Returns the spellID for the talent at the given (tabIndex, talentIndex)
and rank, or nil if the talent index is out of range or the rank slot
is empty. 1.12's GetTalentInfo returns (name, icon, tier, column, currentRank, maxRank, ...) with no spellID; this fills the gap so
addons can chain into the spell APIs without maintaining their own
(class, tab, idx) → spellID lookup tables.
GetTalentSpellID(1, 9) -- 14751 (Inner Focus, single rank)
GetTalentSpellID(1, 1) -- 14525 (Wand Specialization, current rank)
GetTalentSpellID(1, 1, 1) -- 14524 (Wand Specialization rank 1)
GetTalentSpellID(1, 1, 2) -- 14525 (Wand Specialization rank 2)
-- chains into the spell APIs cleanly
GameTooltip:SetSpellByID(GetTalentSpellID(1, 9))
print(C_Spell.GetSpellName(GetTalentSpellID(1, 9))) -- "Inner Focus"
rank is optional. When omitted, defaults to the player's currentRank
by delegating to the engine's existing GetTalentInfo (5th return) —
that's the same player-state derivation the engine uses for talent UI
rendering, including the spell-knowledge checks that account for
talent-granted abilities. If currentRank is 0 (no points spent), falls
back to rank 1 so the function still produces the talent's canonical
spellID for unallocated talents.
When provided explicitly, returns the spellID at that rank regardless of how many points the player has invested. Useful for tooltip-on-hover scenarios where you want to preview "what rank 5 would do" without respec'ing.
Returns nil for:
- non-numeric or non-positive
tabIndex/talentIndex tabIndexortalentIndexout of range for the player's class- explicit
rankexceeding the talent's allocated max — e.g. asking for rank 5 on a 1-rank talent like Inner Focus
Reads the engine's per-tab talent arrays at [0x00BDCD28] (populated
at login from Talent.dbc filtered by class). The SpellRank[] array
lives at offset +0x10 of each TalentEntry (stride 0x54), with
one spellID per rank — vanilla populates indices 0..4 (ranks 1..5),
the higher slots stay zero.
Equivalent to one of GetTalentInfo's extended returns in modern WoW
(varies by version; the talent's spellID has been part of the tuple
since 5.0+).
GetTalentIDByIndex(tabIndex, talentIndex)
Returns the engine's hidden talentID — the primary key of the
Talent.dbc row — for the talent at the given (tab, idx). Returns
nil for out-of-range indices.
GetTalentIDByIndex(1, 9) -- 174 (Inner Focus, Discipline tier 3)
GetTalentIDByIndex(1, 1) -- 166 (first Discipline talent)
1.12's GetTalentInfo(tab, idx) returns
(name, icon, tier, column, currentRank, maxRank, ...) but NOT the
talentID. Modern WoW exposes it (and uses talentIDs as the natural
key for GetTalentInfoByID, talent build sharing strings, etc.); we
add this getter so addons that key on talentIDs from later expansions
work unmodified.
Reads TalentEntry+0x00 from the per-tab talent arrays at
[0x00BDCD28]. Same struct walk as GetTalentSpellID, just reads
a different field.
Equivalent to the talentID return slot of GetTalentInfo in modern
WoW (5.0+; not exposed at all in 1.12).
Time
GetServerTime()
Returns the current server clock as a Unix epoch timestamp (seconds since
1970-01-01 UTC), or nil before login (while the engine's game-time
struct is still BSS-zero).
local now = GetServerTime()
-- now = 1778260148 (Fri 2026-05-08 17:09:08 UTC)
Reads year/month/day/hour/minute from the engine's game-time struct at
0x00CE8538 (populated from SMSG_LOGIN_VERIFY_WORLD /
SMSG_LOGIN_SETTIMESPEED and advanced by the internal tick handler) and
converts via _mkgmtime. Stock GetTime() returns frame-relative
seconds-since-login and is useless for wall-clock alignment; this is the
right call for calendar / log-timestamp / cooldown-sync use cases.
Sub-minute accuracy. The 1.12 wire protocol carries time at minute granularity — the packed gametime field has no seconds — so the engine's clock only steps every minute. We interpolate within the minute using
GetTickCount: whenever we observe the engine's minute change, we anchor to the current tick and add(now - anchor) / 1000seconds for subsequent calls in that minute.The very first call after login lands at second
:00of the current minute (we have no way to know how far in we are when we first see it), so the cold-start value can be off by 0..59 seconds. After the first minute rollover we observe, the anchor lands at the rollover boundary and the timestamp is accurate to within a second of the engine's clock for as long as the session continues.
C_Timer.After(seconds, callback)
Schedules callback to fire once after seconds. Returns nothing.
Backports modern WoW's C_Timer.After as an engine binding (retail
12.0.5 ships this as a Script_* C function, not Lua — we mirror
that shape so addons relying on the modern semantics get
identical behavior).
C_Timer.After(0.5, function() print("half a second later") end)
C_Timer.After(0, function() print("next frame") end)
Errors in the callback are caught (via lua_pcall) and silently
swallowed — same as modern's behavior. One broken timer doesn't
poison other timers on the same tick.
C_Timer.NewTimer(seconds, callback)
Like After, but returns a cancel-handle table:
local handle = C_Timer.NewTimer(10, function() print("never if I cancel") end)
handle:Cancel() -- prevents the callback from firing
print(handle:IsCancelled()) -- true
Cancel() is idempotent; calling it on a timer that already fired
or was previously cancelled is a no-op. IsCancelled() returns
true after Cancel(), after natural expiry, or for an unknown
timer ID. Both methods take no arguments other than self.
C_Timer.NewTicker(seconds, callback, [iterations])
Recurring variant. callback fires every seconds until cancelled
or until iterations fires have happened. iterations is optional;
omitted or non-numeric means forever.
local h = C_Timer.NewTicker(1, function() print("each second") end)
-- ...later
h:Cancel()
-- bounded:
C_Timer.NewTicker(0.25, function() ... end, 8) -- fires 8 times, every 250ms
Minimum period is clamped to 0.0001 to prevent tight loops.
Returns the same kind of cancel handle as NewTimer. The handle
auto-cancels itself when the iteration count exhausts.
Implementation notes (apply to all three functions):
- One unified timer queue walked once per frame from
FUN_WORLD_TICK's subscription. Same hook theBAG_UPDATE_DELAYEDflusher uses, so there's no per-feature hook overhead. - Resolution is one frame (~16ms at 60fps). A timer scheduled for
0.001seconds will fire on the next tick, same as one scheduled for0. - The timer queue uses a monotonic clock (
QueryPerformanceCounter), so timers don't drift if the system clock changes mid-session. - Callbacks are pinned in the Lua registry under per-timer string keys so they survive GC between scheduling and firing.
C_DateAndTime overview
Backport of the modern C_DateAndTime namespace — calendar-style
date math built on top of GetServerTime(). All seven functions
exchange CalendarTime tables with these fields (matching
Blizzard's TimeDocumentation.lua):
| Field | Range | Notes |
|---|---|---|
year |
full year, e.g. 2026 | |
month |
1..12 | luaIndex (1-based) |
monthDay |
1..31 | luaIndex (1-based) |
weekday |
1..7 | luaIndex; 1 = Sunday |
hour |
0..23 | |
minute |
0..59 |
Daily reset semantics.
GetSecondsUntilDailyResettreats reset as midnight in server wall-clock time. This is exactly whatGetServerTime() % 86400 == 0gives you — the engine's gametime components are converted to an epoch by treating them as UTC, so day boundaries in epoch math align with server-clock midnight.Weekly reset not implemented. Vanilla has no server-broadcast weekly reset schedule, and Turtle WoW realm schedules vary, so
C_DateAndTime.GetSecondsUntilWeeklyResetwould have to hardcode a weekday/hour that's wrong on some realms. Addons that need it can compute their own value from the daily reset + a CVAR.
C_DateAndTime.GetCurrentCalendarTime()
Returns the server clock as a CalendarTime table, or nothing before
login. Equivalent to GetCalendarTimeFromEpoch(GetServerTime()).
local t = C_DateAndTime.GetCurrentCalendarTime()
-- t = { year=2026, month=5, monthDay=11, weekday=2, hour=14, minute=30 }
C_DateAndTime.GetCalendarTimeFromEpoch(epoch)
Converts a Unix epoch (seconds since 1970-01-01 UTC) to a
CalendarTime table. Pure gmtime; no engine state touched.
C_DateAndTime.AdjustTimeByDays(date, days) / AdjustTimeByMinutes(date, minutes)
Returns a new CalendarTime offset from the input by the given number
of days (or minutes). Negative deltas walk backwards. Out-of-range
inputs (month=13, monthDay=32) normalize via the underlying
_mkgmtime / gmtime round-trip.
local today = C_DateAndTime.GetCurrentCalendarTime()
local tomorrow = C_DateAndTime.AdjustTimeByDays(today, 1)
local yesterday = C_DateAndTime.AdjustTimeByDays(today, -1)
C_DateAndTime.CompareCalendarTime(lhs, rhs)
Returns -1 if lhs < rhs, 0 if equal, 1 if lhs > rhs.
Compares by epoch conversion so denormalized inputs sort
consistently.
C_DateAndTime.GetServerTimeLocal()
Returns the server's wall clock re-interpreted as a Unix epoch in
the player's local timezone. Useful when you want to feed a
server-clock value into Lua's date(format, epoch) and have the
formatted string show the server's apparent hour/minute. If the
server reports 14:30 and the player is in UTC-5, this returns the
epoch that corresponds to 14:30 in UTC-5 (which is 19:30 UTC).
C_DateAndTime.GetSecondsUntilDailyReset()
Returns seconds until the next server midnight (00:00:00 in server wall-clock time). Returns 0 if called before login.
See the overview's "Daily reset semantics" note — this uses server midnight, not UTC midnight (though they happen to coincide for Turtle WoW since the server reports UTC-aligned components).
UIColor
C_UIColor.GetColors()
Returns an array of rows, each shaped
{ baseTag = "FOO_COLOR", color = ColorMixin }, mirroring the modern
function of the same name. The color field is a real ColorMixin
instance (carries GetRGB, GenerateHexColorMarkup, etc.) — the DLL
calls back into Lua's CreateColor(r,g,b,a) per row to construct it,
so ColorMixin and CreateColor must already be defined when
GetColors is called.
The companion addon !!!ClassicAPI/Util/Color.lua does both: it
defines ColorMixin/CreateColor first, then loops the result the
same way Blizzard_SharedXMLBase/Color.lua does on modern WoW —
assigning each row as a global under its baseTag plus a _CODE
variant holding the |c-prefixed hex markup:
for _, dbColor in ipairs(C_UIColor.GetColors()) do
local color = CreateColor(dbColor.color.r, dbColor.color.g, dbColor.color.b, dbColor.color.a)
_G[dbColor.baseTag] = color
_G[dbColor.baseTag.."_CODE"] = color:GenerateHexColorMarkup()
end
After that runs, addons can use the standard modern color globals directly:
/dump ACHIEVEMENT_COLOR:GetRGB() -- 1, 1, 0
/dump ITEM_EPIC_COLOR:GenerateHexColor()
ITEM_EPIC_COLOR_CODE .. "Legendary" .. "|r"
The data comes from a snapshot of GlobalColor.dbc taken from BC
Classic 2.5.5 (build 67323) — vanilla 1.12 has no GlobalColor.dbc,
so the rows are embedded in the DLL (see src/ui/ColorData.h).
Duplicate baseTags in the source DBC (PURE_RED_COLOR,
INVASION_*, etc.) are deduplicated keeping the higher-ID entry,
matching what ipairs(DBColors) ends up assigning on modern. Colors
introduced after BC (Death Knight runes, Mythic+ medals, healing
absorbs, glyphs, objective tracker) aren't in the snapshot and so
aren't surfaced — none have a use case in 1.12 anyway.
If CreateColor happens not to be defined when GetColors is called
(e.g. another DLL or addon manages to call us before !!!ClassicAPI
loads), each color field falls back to a plain {r,g,b,a} table.
The loop above tolerates both shapes — dbColor.color.r reads the
same way either way — so consumers shouldn't notice.
Unit
UnitGUID(unit)
Returns the unit's 64-bit GUID formatted as a hex string
"0xHHHHHHHHLLLLLLLL" (16 hex digits, hi dword first), or nil if the
resolved unit's GUID is empty (e.g. "target" with nothing targeted,
empty party/raid slot).
local guid = UnitGUID("player") -- "0x0000000000000777" (low IDs are local-realm characters)
local guid = UnitGUID("target") -- "0xF13000059A002553" (the F130... prefix tags creatures)
local guid = UnitGUID("party1") -- works even if party1 is on a different continent
Works for OOR party / raid members. Earlier versions of this
function returned nil for "partyN" / "raidN" when the member's
CGObject wasn't currently active in the client (e.g. on another
continent, in a different zone phase). We now read from the engine's
parallel group-roster GUID array (populated by SMSG_GROUP_LIST),
which is independent of unit visibility.
Vanilla format, not modern. Vanilla GUIDs are plain 64-bit integers — there's no
"Player-RealmID-CharacterID"/"Creature-0-0-MapID-..."prefix system that modern WoW uses (introduced in 6.0). Addons backporting modern GUID-parsing code will need to either accept the"0x..."form or extract the raw hex.
Errors on invalid unit tokens. Same behavior as vanilla's other unit-token functions (
UnitAffectingCombat,UnitName, etc.) — passing a string that doesn't match a known unit ID raises a Lua error rather than returning nil. Modern WoW silently returns nil; we match the engine's existing convention here. Unit tokens that resolve to "no current unit" (like"target"with nothing targeted) return nil cleanly via the GUID = 0 check.
UnitTokenFromGUID(guid)
Best-effort reverse lookup: given a GUID string in the
"0xHHHHHHHHLLLLLLLL" format UnitGUID returns, walk the engine's
known unit tokens and return the first one currently mapped to that
GUID, or nil if none of them point at it.
The search order matches modern retail with post-1.12 tokens
omitted (vehicle, nameplateN, arenaN, arenapetN, bossN,
focus, softenemy, softfriend, softinteract all post-date
vanilla and the engine's resolver doesn't recognize them):
player → pet → party1..4 → partypet1..4 → raid1..40
→ raidpet1..40 → target → npc → mouseover
local name, guid = GameTooltip:GetUnitGUID()
local token = UnitTokenFromGUID(guid)
if token then
-- can now feed `token` to UnitHealth / UnitClass / etc.
end
The return is inherently unstable. Multiple tokens can map to the same GUID at once (your target IS your party1, your pet IS your raidpet5 if you're in a raid), and the mapping changes every time
SMSG_GROUP_LISTfires, the player tabs target, or a party member loads in. Modern's API has the same warning. If you cache a result, re-verify withUnitGUID(token) == originalGuidbefore reusing it.Returns
nilfor malformed GUID strings, zero GUIDs, and GUIDs that don't match any currently-resolvable token — including ex-targets, ex-mouseover units, distant players seen in the chat log, etc. The engine simply doesn't address those by token.
GetUnitSpeed(unit)
Returns currentSpeed, runSpeed, flightSpeed, swimSpeed — all four
in yards/second. Modern WoW signature exactly; 1.12 doesn't have
flying, so flightSpeed is always 0.
local current, run, _, swim = GetUnitSpeed("player")
-- e.g. 7.0, 7.0, 0, 4.722 for an unmounted player running normally
-- e.g. 14.0, 14.0, 0, 4.722 with a 100% mount active (run speed
-- reflects the modifier; swim ignores mount)
currentSpeed— speed the engine would apply to this frame's movement step.0when stationary; otherwise the walk/run/swim/ backward variant the unit is actually moving with. Read via the engine's own selector at0x007C4C90so movement-flag handling (walking, swimming, taxi paths) matches the engine exactly.runSpeed— raw forward-run speed from MovementInfo+0x8C. Includes mount / buff / debuff multipliers — the engine maintains this field as the post-modifier value, updated bySMSG_FORCE_RUN_SPEED_CHANGEand friends.flightSpeed— always0in 1.12.swimSpeed— raw forward-swim speed from MovementInfo+0x94.
All four returns are 0 if the token doesn't resolve to a live
CGUnit — empty "target", out-of-range party member, etc. Matches
3.3.5's Script_GetUnitSpeed behavior of pushing 0.0 rather than
nil for non-visible units.
Reads [CGUnit + 0x118] to get the MovementInfo pointer, then
reads speed fields directly. Field offsets verified via the
movement-prediction loop (FUN_005FC350 and the sprint-jump
calculator at 0x00511920 both reach into the same struct).
UnitIsAFK(unit)
Returns true if the unit is currently AFK (toggled via /afk or
auto-set after idle timeout). Works for any player-controlled unit
— local self, target, party*, raid*, inspect targets. NPCs always
return false.
UnitIsAFK("player") -- true if you've /afk'd
UnitIsAFK("target") -- true if the targeted player is AFK
UnitIsAFK("party1") -- true if party member 1 is AFK
UnitIsAFK("npc") -- always false
How it works under the hood. Vanilla 1.12 doesn't broadcast PLAYER_FLAGS as a UpdateField (modern WoW does — that field was added 3.0+), but every nearby player's CGPlayer-side info struct at
[unit + 0xE68]carries it at byte +0x08. Same struct the engine reads when rendering the<AFK>prefix above a player's head. Verified against the in-game nameplate behavior.
UnitIsDND(unit)
Returns true if the unit is currently in DND mode ("Do Not Disturb",
toggled via /dnd). Same unit-coverage as UnitIsAFK — any
player-controlled unit, false for NPCs.
UnitIsDND("player")
UnitIsDND("target")
UnitIsFeignDeath(unit)
Returns true if the unit is feigning death (Hunter's Feign Death).
Reads UNIT_FIELD_FLAGS bit 29 (0x20000000) from the broadcast
descriptor — works for any unit since UNIT_FIELD_FLAGS is broadcast
in object updates.
UnitIsFeignDeath("target") -- true if a feigning hunter
UnitIsInMyGuild(unitOrName)
Returns 1 if the unit/character shares the player's guild, nil
otherwise. Accepts either a unit token ("player", "target",
"party1", etc.) or a literal character name ("Bob"), matching
3.3.5's Script_UnitIsInMyGuild (0x0060C4B0 in the Frostmourne
client).
UnitIsInMyGuild("player") -- 1 if you're in any guild
UnitIsInMyGuild("target") -- 1 if your target is a guildmate
UnitIsInMyGuild("party1") -- 1 if party member 1 is a guildmate
UnitIsInMyGuild("Bob") -- 1 if there's a guildmate named Bob
Resolution strategy:
- Calls
UnitName(input)vialua_pcallto canonicalize the input. Tokens resolve cleanly; literal names hit the engine's "Unknown unit name" error whichpcallswallows. - For valid tokens, attempts a fast direct comparison against the
player's guild-key field at
[unit + 0xE68 + 0x0C]— same fieldGetGuildInforeads, populated immediately on guild join for the local player and for any synced player-controlled unit. No roster fetch needed for nearby/loaded units. - Falls back to walking the engine's guild roster array (same
backing storage
GetGuildRosterInforeads) by name. Required for out-of-range party members, distant raid members, and literal name input — needsGuildRoster()to have been called and the server's response to have arrived.
Return convention matches 3.3.5: 1.0 / nil, not boolean. Both
work for if UnitIsInMyGuild(x) then checks.
The slow path reads the engine's full roster count
([0x00B73118], the same value GetNumGuildMembers(true) returns),
not the online-only count, so offline guildmates resolve too — the
"show offline" toggle doesn't affect lookup. The only requirement
is that GuildRoster() has been called and the server's
SMSG_GUILD_ROSTER response has arrived.
UnitIsPossessed(unit)
Returns true if the unit is currently possessed (priest's Mind Control, warlock's Subjugate Demon). Reads UNIT_FIELD_FLAGS bit
24 (0x01000000) — the standard vanilla UNIT_FLAG_POSSESSED per
emulator sources — directly off the unit's m_objectFields descriptor.
Works for any unit token since UNIT_FIELD_FLAGS is broadcast in
object updates.
UnitIsPossessed("target") -- true if mind-controlled
Distinct from UnitIsCharmed: charm covers any charm-type effect
(including pets summoned via mob-charm spells), possess is the
specific spell-driven take-over effect modern WoW splits out.
UnitStandState(unit)
Returns the unit's standstate as an integer, matching the modern
Enum.PlayerStandState values:
| Value | Meaning |
|---|---|
0 |
STANDING |
1 |
SITTING |
2 |
SITTING_CHAIR |
3 |
SLEEPING |
4 |
SITTING_LOW_CHAIR |
5 |
SITTING_MEDIUM_CHAIR |
6 |
SITTING_HIGH_CHAIR |
7 |
DEAD |
8 |
KNEELING |
Reads the low byte of UNIT_BYTES_1 (descriptor +0x210), a
broadcast UpdateField — works for any synced unit (player, target,
party*, raid*, mouseover, etc.). Returns 0 (STANDING) for
unresolvable units (empty party* slot, no current target, etc.)
matching the modern behavior of returning a safe default.
UnitStandState("player") -- 0 standing, 1 sitting, 5 chair-sit, …
UnitStandState("target") -- works for any visible unit
UnitStandState("party1") -- 0 if the slot is empty
1.12 has IsSitOrStanding() (local-player boolean) but no
unit-token form; UnitStandState fills the gap and exposes the
full enum.
UnitInRange(unit)
Returns (inRange, checkedRange) — whether unit is within 40 yards
of the player, plus a flag indicating whether the range check could
actually be performed.
local inRange, checked = UnitInRange("party1")
if checked and not inRange then
-- partymate is loaded but >40 yards away → skip the heal
end
| Return | Meaning |
|---|---|
inRange |
true if the unit's world position is within 40 yards of the player's. false if out of range OR if checkedRange is false. |
checkedRange |
true when a position-based range check was performed. false when the unit's position isn't available — either the token didn't resolve (empty partyN slot, no target, raid member in a different zone, etc.) or unit == "player" (see below). |
Reads the world position via the CGObject::GetPosition vtable
virtual (slot 5, offset +0x14) — same path
CheckInteractDistance uses. Squared-distance compare against
40 * 40 = 1600.
UnitInRange("player")returns(false, false)by design, matching modern WoW's behavior. The function is meant for healing- frame "is another unit in range" checks; querying yourself is meaningless. We short-circuit before the position read so the result is unambiguous (checkedRange=false).
Works for any synced unit (party/raid members in your zone, target,
mouseover, etc.). For raid members in a different zone or otherwise
not in the engine's sync window, the position virtual returns null
and the function reports (false, false).
UnitClassBase(unit)
Returns (classFile, classID) — the locale-independent class
token plus the numeric classID. The token is one of
"WARRIOR", "PALADIN", "HUNTER", "ROGUE", "PRIEST",
"SHAMAN", "MAGE", "WARLOCK", "DRUID"; the classID matches
the integer UnitClass's third return surfaces (1=Warrior,
2=Paladin, 3=Hunter, 4=Rogue, 5=Priest, 7=Shaman, 8=Mage,
9=Warlock, 11=Druid — 6 and 10 are post-vanilla).
local token, id = UnitClassBase("player") -- "WARRIOR", 1
local token = UnitClassBase("target") -- works for any synced unit
local color = RAID_CLASS_COLORS[UnitClassBase("party1")]
Modern addons use the token for class detection because vanilla's
UnitClass(unit) returns a localized first return (e.g.
"Krieger" on a German client), which is fine for display but
breaks any addon code that keys on if class == "WARRIOR". The
classID second return is a vanilla extension — modern's
UnitClassBase returns the token only — but it saves callers
from chaining UnitClass(unit) just to get the integer.
Reads the class byte from UNIT_FIELD_BYTES_0 (descriptor +0x79,
the same byte UnitClass's general-token path reads) and looks up
the english filename at ChrClasses.dbc::Filename (record +0x38).
Both fields are broadcast / static, so remote players' class is
current regardless of distance.
Returns (nil, nil) for:
targetwith no current target, emptypartyN/raidNslots, or units whose descriptor isn't loaded yet- creatures and other non-player units (their class byte indexes a different table; the class-byte lookup naturally returns nil for out-of-range / zero values)
Throws a Lua error on missing / non-string unit argument — same
shape as UnitClass itself.
UnitRaceBase(unit)
Returns (raceFile, raceID) — the locale-independent race token
plus the numeric raceID. The token is one of "Human", "Orc",
"Dwarf", "NightElf", "Scourge", "Tauren", "Gnome",
"Troll"; the raceID is 1..8 for those values respectively.
local token, id = UnitRaceBase("player") -- "Human", 1
local token = UnitRaceBase("target") -- works for any synced unit
Sibling to UnitClassBase. Same problem
(vanilla's UnitRace(unit) returns a localized name — "Mensch",
"Orc", etc.); same solution (locale-independent token straight
from the DBC). Reads byte 0 of UNIT_FIELD_BYTES_0 (descriptor
+0x78) and looks up ChrRaces.dbc::Filename (+0x3C).
Returns (nil, nil) for unresolvable units and non-player units
(creature race bytes don't index ChrRaces.dbc).
UnitPower(unit [, powerType]) / UnitPowerMax(unit [, powerType])
Modern multi-power-type getters. Vanilla 1.12 only ships
UnitMana(unit) / UnitManaMax(unit) which return whichever
primary power the unit happens to have (mana for casters, energy
for rogues, rage for warriors, etc.); these add the explicit
powerType arg so addons can read a specific power slot without
caring what the unit's primary is.
local mana = UnitPower("player", 0) -- explicit mana
local energy = UnitPower("player", 3) -- explicit energy
local primary = UnitPower("player") -- whatever the player's primary is
local maxMana = UnitPowerMax("target", 0)
powerType values (matches modern WoW's enum):
| value | type |
|---|---|
0 |
MANA |
1 |
RAGE |
2 |
FOCUS |
3 |
ENERGY |
4 |
HAPPINESS |
These match the Enum.PowerType namespace published
alongside — UnitPower("player", Enum.PowerType.Mana) is the
idiomatic modern shape.
Omitting powerType (or passing -1 / any out-of-range value)
falls back to the unit's primary power, read from
UNIT_FIELD_BYTES_0 byte 3 (descriptor +0x7B) — same source the
vanilla engine uses internally. Same fallback the 3.3.5 client's
Script_UnitPower uses for its type == 7 sentinel.
Returns 0 for invalid units, unresolvable tokens, or power types
outside the 0..4 vanilla range (Runes / Runic Power are WotLK
additions that don't have descriptor slots in the 1.12 unit
layout).
Display-divisor applied. Vanilla stores some power types at a
scaled value internally and divides before exposing them through
Lua — same trick Script_UnitMana (0x00517670) uses, reading
the divisor table at 0x0086F978:
| type | divisor |
|---|---|
0 MANA |
1 |
1 RAGE |
10 (raw 0..1000 → display 0..100) |
2 FOCUS |
1 |
3 ENERGY |
1 |
4 HAPPINESS |
1000 |
So a fresh warrior reads UnitPower("player", 1) = 0..100, not
0..1000. Matches retail Classic.
Direct descriptor reads — desc[+0x44 + type*4] for current power,
desc[+0x5C + type*4] for max, divided by the table entry for the
type. No engine call, no Lua-stack roundtrip.
UnitPowerType(unit)
Vanilla 1.12 ships this returning just the integer power type;
this implementation extends it to the modern 2-tuple
(powerType, powerToken). Strict-superset signature — addons
that destructure only the first return are unaffected.
local pt, token = UnitPowerType("player")
-- e.g. (0, "MANA") for a paladin, (1, "RAGE") for a warrior
Token strings match modern WoW exactly:
| value | token |
|---|---|
0 |
"MANA" |
1 |
"RAGE" |
2 |
"FOCUS" |
3 |
"ENERGY" |
4 |
"HAPPINESS" |
5 |
"RUNES" |
6 |
"RUNIC_POWER" |
5/6 are post-WotLK power types that can't appear on a 1.12 unit's descriptor; they're included in the table for symmetry with the modern enum in case a private server pushes one through.
Chains to the engine's original Script_UnitPowerType at
0x00517940 to preserve its full unit-resolution flow (object-
manager lookup with pet / totem / vehicle fallbacks), then reads
the just-pushed integer and appends the token string.
UnitAuras
Backport of the modern C_UnitAuras namespace. Returns
AuraData-shaped tables instead of vanilla's UnitBuff /
UnitDebuff multi-return tuples, so modern addon code that does
local d = C_UnitAuras.GetAuraDataByIndex(unit, 1); if d.dispelName == "Magic" then ... works unchanged.
Reads everything off the unit's m_objectFields descriptor — same
data source UnitBuff / UnitDebuff use. The descriptor has 48 aura
slots total: 32 helpful (buffs) at indices 0..31, 16 harmful
(debuffs) at indices 32..47. Functions in this namespace take a
1-based Lua index that translates onto whichever range the filter
selects.
AuraData table shape
| Field | Type | Source / value on vanilla |
|---|---|---|
name |
string | localized spell name from Spell.dbc |
icon |
string | icon path from SpellIcon.dbc |
applications |
number | stack count (engine stores stacks-1, we display +1) |
spellId |
number | spell ID from the descriptor's aura array |
dispelName |
string | "Magic" / "Curse" / "Disease" / "Poison" (from SpellDispelType.dbc), or "" if non-dispellable |
isHelpful |
boolean | true for slot < 32 |
isHarmful |
boolean | true for slot >= 32 |
duration |
number | base applied duration in seconds, looked up via Spell.dbc → SpellDuration.dbc with level scaling. Talent / glyph duration extensions (Improved PW:F, etc.) aren't reflected here — those are baked into expirationTime on the caster's side. Returns 0 for spells flagged "no duration" (passives, paladin auras, infinite buffs) |
expirationTime |
number | populated for unit == "player" (read from the engine's player-buff table at 0x00BC6040; same data GetPlayerBuffTimeLeft returns). Always 0 for all other units — vanilla server only broadcasts cast/duration for the local player's own auras. expirationTime - GetTime() gives the true remaining time (including any talent extensions) |
charges / maxCharges |
number | always 0 — vanilla has stacks, not charges |
timeMod |
number | always 1 — vanilla has no haste-affected auras |
isStealable, isBossAura, isFromPlayerOrPlayerPet, isNameplateOnly, nameplateShowAll, nameplateShowPersonal, canApplyAura, shouldConsolidate, isRaid |
boolean | always false — modern UI concepts vanilla doesn't have |
sourceUnit, auraInstanceID, points |
(absent) | omitted from the table — Lua read yields nil, matching modern semantics for "field doesn't apply" |
Filter parsing
The optional filter string is a pipe-separated set of upper-case
tokens, matching modern syntax ("HELPFUL", "HARMFUL",
"HELPFUL|PLAYER", etc.). Only HELPFUL (default) and HARMFUL
are honored on vanilla; other tokens (PLAYER / RAID /
CANCELABLE / INCLUDE_NAME_PLATE_ONLY) are accepted but no-op —
they'd need source-GUID tracking or systems vanilla doesn't have.
C_UnitAuras.GetAuraDataByIndex(unit, index [, filter])
Returns the AuraData table for the index-th aura (1-based)
matching filter, or nil if the unit has fewer than index
matching auras. Empty / non-visible descriptor slots are skipped
during iteration, so consecutive indices return consecutive active
auras the same way UnitBuff does.
local d = C_UnitAuras.GetAuraDataByIndex("player", 1, "HELPFUL")
if d then
print(d.name, d.spellId, d.dispelName, d.applications)
end
C_UnitAuras.GetBuffDataByIndex(unit, index) / GetDebuffDataByIndex(unit, index)
Convenience wrappers locking the filter to HELPFUL or HARMFUL
respectively. Equivalent to GetAuraDataByIndex(unit, index, "HELPFUL") / "HARMFUL".
C_UnitAuras.GetUnitAuraBySpellID(unit, spellID [, filter])
Linear-searches unit's aura array for the first populated slot
whose spellId matches and returns its AuraData, or nil if not
found. Without a filter, searches both ranges (helpful first, then
harmful).
-- Is the player blessed with Wisdom right now?
local d = C_UnitAuras.GetUnitAuraBySpellID("player", 25290)
if d then print("yes, with", d.applications, "stacks") end
C_UnitAuras.GetPlayerAuraBySpellID(spellID)
Shorthand for GetUnitAuraBySpellID("player", spellID) — the most
common consumer pattern (WeakAuras-style aura tracking).
C_UnitAuras.GetAuraDataBySpellName(unit, spellName [, filter])
Linear-searches unit's aura array for the first populated slot
whose locale-resolved name matches spellName exactly. Returns
the AuraData for that slot or nil if not found. Case-sensitive
— matches modern semantics. Without a filter, searches both
ranges (helpful first, then harmful).
local d = C_UnitAuras.GetAuraDataBySpellName("player", "Inner Fire")
if d then print(d.applications, "stacks of Inner Fire") end
-- restrict to debuffs:
local poison = C_UnitAuras.GetAuraDataBySpellName(
"target", "Mind-numbing Poison", "HARMFUL")
Uses the same name field the other C_UnitAuras.* functions
populate (locale-applied Spell.dbc name). If the player is on
a non-English client, pass the localized name — addons that
hard-code English names should use GetUnitAuraBySpellID
instead for portability.
C_UnitAuras.GetUnitAuras(unit [, filter])
Returns a numerically-indexed array of AuraData tables for every
populated aura on unit. Without a filter the array is helpful auras
followed by harmful; with a filter it's restricted to one range.
Empty array ({}) if the unit has no auras or doesn't resolve.
for _, aura in ipairs(C_UnitAuras.GetUnitAuras("target")) do
print(aura.spellId, aura.dispelName, aura.isHarmful)
end
C_UnitAuras.GetAuraDispelTypeColor(dispelName)
Returns a {r, g, b, a} table for the given dispel-type name,
matching modern FrameXML's DebuffTypeColor values:
| dispelName | r | g | b |
|---|---|---|---|
"Magic" |
0.20 | 0.60 | 1.00 |
"Curse" |
0.60 | 0.00 | 1.00 |
"Disease" |
0.60 | 0.40 | 0.00 |
"Poison" |
0.00 | 0.60 | 0.00 |
"Enrage" |
1.00 | 0.55 | 0.00 |
(anything else, including "") |
0.80 | 0 | 0 |
Returns a ColorMixin instance the same way modern does — the C
function pcalls Lua's CreateColor(r, g, b, a) (defined in
!!!ClassicAPI/Util/Color.lua) and returns whatever table it
builds. So the returned value carries the mixin methods
(GetRGB, GenerateHexColorMarkup, etc.) in addition to the
.r/.g/.b/.a fields. Falls back to a plain {r,g,b,a} table if
CreateColor isn't loaded yet (shouldn't happen — !!!ClassicAPI
loads first thanks to the triple-! prefix).