--[[
NampowerAPI.lua - Nampower API Integration Layer
Provides wrapper functions for Nampower's extended Lua API with fallbacks
for older versions or when functions are unavailable.
Core Nampower Functions Wrapped (v2.8+):
- GetSpellRec / GetSpellRecField - Spell record data from client DB
- GetItemStats / GetItemStatsField - Item stats from client DB
- GetUnitData / GetUnitField - Low-level unit field access
- GetSpellModifiers - Spell modifier calculations (talents, buffs, etc.)
Inventory/Equipment Functions (v2.18+):
- FindPlayerItemSlot - Fast item location lookup
- GetEquippedItems / GetEquippedItem - Equipment inspection
- GetBagItems / GetBagItem - Bag contents inspection
- GetCastInfo - Detailed cast/channel/GCD information
- GetSpellIdCooldown / GetItemIdCooldown - Detailed cooldown info with item metadata
Trinket/Item Functions (v2.20+):
- GetTrinkets - Enumerate equipped and bagged trinkets
- GetTrinketCooldown - Get trinket cooldown by slot/ID/name
- UseTrinket - Use trinket by slot/ID/name with optional target
- UseItemIdOrName - Use any item by ID/name with optional target
Enhanced Functions (accept spell name or "spellId:number"):
- GetSpellTexture, GetSpellName, GetSpellCooldown, GetSpellAutocast
- ToggleSpellAutocast, PickupSpell, CastSpell, IsCurrentCast, IsSpellPassive
Copy Parameter (v2.20+):
- Most table-returning functions now accept [copy] parameter
- Pass 1 to get independent copy safe for storage
- Without copy, table references are reused - extract values immediately!
Utility Functions (v2.22+):
- DisenchantAll - Auto-disenchant items by ID/name or quality
Cooldown Detail Tables (v2.23+):
- GetSpellIdCooldown/GetItemIdCooldown now include item metadata:
itemId, itemHasActiveSpell, itemActiveSpellId
Auto-Attack Events (v2.24+):
- AUTO_ATTACK_SELF / AUTO_ATTACK_OTHER events
- Detailed hit info: damage, crit/glancing/crushing, dodge/parry/block
- Requires NP_EnableAutoAttackEvents=1 CVar to enable
Spell Start/Go Events (v2.25+):
- SPELL_START_SELF / SPELL_START_OTHER - Server notifies cast time spell begun
- SPELL_GO_SELF / SPELL_GO_OTHER - Server notifies spell completed casting
- Requires NP_EnableSpellStartEvents=1 and NP_EnableSpellGoEvents=1 CVars
Spell Heal/Energize Events (v2.26+):
- SPELL_HEAL_BY_SELF / SPELL_HEAL_BY_OTHER / SPELL_HEAL_ON_SELF
- SPELL_ENERGIZE_BY_SELF / SPELL_ENERGIZE_BY_OTHER / SPELL_ENERGIZE_ON_SELF
- Requires NP_EnableSpellHealEvents=1 and NP_EnableSpellEnergizeEvents=1 CVars
Texture Lookup Functions (v2.27+):
- GetItemIconTexture(displayInfoId) - Get item texture path from display info ID
- GetSpellIconTexture(spellIconId) - Get spell texture path from spell icon ID
Nameplate GUID (v2.28+):
- CSimpleFrame:GetName(1) returns nameplate unit GUID
Ammo Query (v2.29+):
- GetAmmo() - Returns equipped ammo item ID and total count
Aura Slot Extensions (v2.30+):
- auraSlot parameter on BUFF/DEBUFF_ADDED/REMOVED events (raw 0-based slot)
- BUFF_UPDATE_DURATION_SELF / DEBUFF_UPDATE_DURATION_SELF events
- GetPlayerAuraDuration(auraSlot) - Get duration info for player aura by slot
Spell Miss Events (v2.31+):
- SPELL_MISS_SELF / SPELL_MISS_OTHER - Spell miss/resist/immune/dodge/etc.
Aura Event State Parameter (v2.32+):
- Buff/debuff events include 7th `state` parameter (0=added, 1=removed, 2=modified)
- REMOVED events now properly fire for stack decrements (state=2)
Duration Event SpellId (v2.33+):
- BUFF/DEBUFF_UPDATE_DURATION_SELF include spellId as 4th parameter
- GetCastInfo() guid field fix (no code change needed)
Settings Integration:
- Reads from NampowerSettings addon when available
- Falls back to CVars when addon not present
Aura Cancel Functions (v2.34+):
- CancelPlayerAuraSlot(auraSlot) - Cancel buff/debuff by raw 0-based aura slot
- CancelPlayerAuraSpellId(spellId, [ignoreMissing]) - Cancel buff/debuff by spell ID
Pass ignoreMissing=1 to skip aura-slot presence check (for server-side
overflow buffs that have no client aura slot in the 48-slot array)
GUID String Fix & Talent Helper (v2.35+):
- GetUnitData/GetUnitField now return GUID-type fields (charm, summon, charmedBy,
summonedBy, createdBy, target, persuaded, channelObject) as hex strings
(e.g., "0x0600000012345678") instead of raw numbers to avoid Lua 64-bit precision loss
- LearnTalentRank(talentPage, talentIndex, rank) - Learn a specific talent rank directly
Player State Functions (v2.36+):
- PlayerIsMoving() - Returns 1 if player is moving, nil if stationary
- PlayerIsRooted() - Returns 1 if player is rooted, nil if not
- PlayerIsSwimming() - Returns 1 if player is swimming, nil if not
Unit Token Cast & Mouseover (v2.37+):
- CastSpellByName(spellName, unitToken) - 2nd param now accepts unit token strings
(e.g. "mouseover", "party1", "focus") in addition to GUIDs and 1 (self).
Enables soft-casting on unit tokens without changing the player's visible target.
- SetMouseoverUnit(unitToken) - Programmatically set the mouseover unit.
Previously only available via SuperWoW; now also provided by Nampower.
Spell Duration & Enhanced SPELL_START (v2.38+):
- GetSpellDuration(spellId, [ignoreModifiers]) - Returns duration in ms.
For channeling spells: channel duration. For others: first aura effect duration.
Pass ignoreModifiers=1 to get base duration (ignores talents/buffs).
Returns 0 if spell has no duration, nil if spellId invalid.
- SPELL_START_SELF / SPELL_START_OTHER now include two new parameters:
arg7 = duration (ms) - channel duration for channeling spells, 0 otherwise
arg8 = spellType - 0=Normal, 1=Channeling, 2=Autorepeating
Use spellType to distinguish channeling spells (SPELL_START_OTHER carries both
cast-time and channeling spells since there is no separate SPELL_CHANNEL_START
packet for other players).
Unit GUID Events (v2.39+):
- New GUID-based unit events fire once per unit state change instead of once per
registered token. Each event carries GUID + flags for player/target/mouseover/pet/
party/raid membership. Avoids event spam from per-token firing.
- Events: UNIT_HEALTH_GUID, UNIT_MANA_GUID, UNIT_RAGE_GUID, UNIT_ENERGY_GUID,
UNIT_PET_GUID, UNIT_FLAGS_GUID, UNIT_AURA_GUID, UNIT_DYNAMIC_FLAGS_GUID,
UNIT_NAME_UPDATE_GUID, UNIT_PORTRAIT_UPDATE_GUID, UNIT_MODEL_CHANGED_GUID,
UNIT_INVENTORY_CHANGED_GUID, PLAYER_GUILD_UPDATE_GUID
- UNIT_COMBAT_GUID: fires once per combat feedback event with full combat detail
(action, damage, school, hitInfo) instead of per token.
- Granular CVars to control which unit tokens fire standard UNIT_* events:
NP_EnableUnitEventsPet (default 1), NP_EnableUnitEventsParty (default 1),
NP_EnableUnitEventsRaid (default 1), NP_EnableUnitEventsMouseover (default 1),
NP_EnableUnitEventsGuid (default 1), NP_EnableUnitEventsGuidFiltering (default 1)
Corpse Guid & Packed GUID Fix (v2.40+):
- SPELL_START_SELF/OTHER now include arg9 = corpseOwnerGuid (string or nil):
GUID of the player who owns the corpse target; nil if no corpse target.
- SPELL_GO_SELF/OTHER now include arg8 = corpseOwnerGuid (string or nil).
- Fixed packed GUID parsing bug that caused target to appear as "0x000000000"
for some player GUIDs.
Keyboard Events & Extended Unit Token Support (v2.41+):
- KEY_DOWN / KEY_UP events: fire when keyboard keys are pressed and released.
Any addon can register for these to react to key input without frame scripts.
- Internal unit token resolver extended: all Nampower functions that accept a
unit string (SetMouseoverUnit, UseItemIdOrName, CastSpellByName, etc.) now
support additional formats beyond standard tokens and GUIDs:
mark1..mark8 - resolve to the unit bearing that raid marker
owner - owner of (e.g. "targetowner" = target's owner)
target - target of (e.g. "mouseovertarget")
pet - pet of (e.g. "party1pet")
can be a standard token, a GUID string, or a mark token.
Suffix matching is case-insensitive.
Note: GetGUIDFromName is an internal C++ helper, NOT a new Lua global.
GetUnitGUID Rename, IsAuraHidden, Hidden Aura luaSlot Fix (v3.0+):
- UnitGUID renamed to GetUnitGUID (global function). The addon uses SuperWoW's
UnitExists for GUIDs so this rename is not breaking, but GetUnitGUID supports
extended tokens (mark1-mark8, owner/target/pet suffixes).
- IsAuraHidden(spellId): returns 1 if the spell's aura is hidden from Lua aura
APIs (UnitBuff/UnitDebuff won't show it). Useful for detecting hidden CC spells.
- luaSlot in BUFF/DEBUFF events now returns 0 for hidden auras (was incorrect before).
No-Queue Cast by ID & SPELL_CAST_EVENT Target Default (v3.1+):
- CastSpellNoQueue(spellId, spellBook [, unit]) - Cast by spell ID without spell queueing.
spellBook: 0 for player spells, "pet" for pet spells.
Optional unit parameter for targeting (same tokens as CastSpellByName).
- CastSpellByNameNoQueue now accepts unit token as second parameter (same as CastSpellByName).
- SPELL_CAST_EVENT targetGuid now defaults to current target's GUID instead of null GUID
("0x0000000000000000"). Still overridden by explicit target (CastSpellByName 2nd param,
SpellTargetUnit mouseover).
File I/O, Combat Log Flush, Encrypted Login, and Backwards-Compatible Import/Export (v3.2+):
- WriteCustomFile(filename, content, [mode]) - Write to CustomData directory.
mode: "w" (overwrite, default), "a" (append), "b" (binary).
- ReadCustomFile(filename) - Read from CustomData directory. Returns nil if not found.
- CustomFileExists(filename) - Check file existence in CustomData directory.
- ExecuteCustomLuaFile(filename) - Execute a .lua file from CustomData directory.
- ImportFile(filename) - Read from Imports directory (.txt appended automatically).
Backwards compatibility with SuperWoW; patched security issues.
- ExportFile(filename, text) - Write to Imports directory (.txt appended automatically).
- CombatLogFlush() - Immediately flush combat log buffer to disk.
- EncryptPassword(password) / EncryptedServerLogin(username, encryptedBase64) -
GlueXML-only encrypted login helpers using Windows DPAPI.
Chat Bubble Controls, Demon Autocast Enhancements (v3.3+):
- Enhanced chat bubble controls via CVars: NP_ChatBubbleDistance,
NP_ChatBubblesWhisper, NP_ChatBubblesRaid, NP_ChatBubblesBattleground.
- NP_PreserveGreaterDemonAutocast now also saves/restores reaction states
(aggressive/defensive/passive) including for infernal.
- CastSpell now handles spells not in DBC gracefully.
Environmental Damage, Damage Shield, Dispel Events (v3.4+):
- ENVIRONMENTAL_DMG_SELF / ENVIRONMENTAL_DMG_OTHER - Environmental damage events
(exhaustion, drowning, fall, lava, slime, fire). Params: unitGuid, dmgType,
damage, absorb, resist. No CVar needed.
- DAMAGE_SHIELD_SELF / DAMAGE_SHIELD_OTHER - Damage shield events (Thorns, etc.).
Params: unitGuid, targetGuid, damage, spellSchool. No CVar needed.
- SPELL_DISPEL_BY_SELF / SPELL_DISPEL_BY_OTHER - Spell dispel events.
Params: casterGuid, targetGuid, spellId. No CVar needed.
GetSpellRangeData, GUID Event Init Fix (v4.0+):
- GetSpellRangeData(rangeIndex) - Returns minRange, maxRange, flags, name for a
SpellRange DBC entry. flags=0 is ranged, flags=1 is melee (Combat Range).
Use with GetSpellRecField(spellId, "rangeIndex") to look up a spell's range.
- Hooks initialized later so _GUID events work even with old perf_boost.
PvP Unit Data Revert (v4.1+):
- v4.0 restricted GetUnitData/GetUnitField and suppressed BUFF/DEBUFF_ADDED/REMOVED_OTHER
for PvP-flagged attackable units. v4.1 reverts this — the information is already
accessible via tooltips in the base game.
Current version: v4.0.0
]]
local _G = _G or getfenv(0)
local CleveRoids = _G.CleveRoids
-- Nampower API namespace
-- Force table creation if not already a table (guards against addon conflicts)
if type(CleveRoids.NampowerAPI) ~= "table" then
CleveRoids.NampowerAPI = {}
end
local API = CleveRoids.NampowerAPI
--------------------------------------------------------------------------------
-- VERSION DETECTION AND FEATURE FLAGS
--------------------------------------------------------------------------------
-- Cached version info (set during initialization)
API._version = { major = 0, minor = 0, patch = 0, initialized = false }
-- Get Nampower version as major, minor, patch
-- Returns 0, 0, 0 if Nampower not installed
function API.GetVersion()
if API._version.initialized then
return API._version.major, API._version.minor, API._version.patch
end
if GetNampowerVersion then
local major, minor, patch = GetNampowerVersion()
API._version.major = major or 0
API._version.minor = minor or 0
API._version.patch = patch or 0
end
API._version.initialized = true
return API._version.major, API._version.minor, API._version.patch
end
-- Get version as a single comparable number (e.g., 2.18.3 -> 2018003)
function API.GetVersionNumber()
local major, minor, patch = API.GetVersion()
return (major * 1000000) + (minor * 1000) + patch
end
-- Check if installed version meets minimum requirement
function API.HasMinimumVersion(reqMajor, reqMinor, reqPatch)
local major, minor, patch = API.GetVersion()
if major > reqMajor then
return true
elseif major == reqMajor then
if minor > reqMinor then
return true
elseif minor == reqMinor and patch >= (reqPatch or 0) then
return true
end
end
return false
end
-- Version requirements for each feature group
-- Format: { major, minor, patch, globalFunction (optional verification) }
API.VERSION_REQUIREMENTS = {
-- v2.0+ - Base spell queuing
["SpellQueue"] = { 2, 0, 0, "QueueSpellByName" },
["GetCurrentCastingInfo"] = { 2, 0, 0, "GetCurrentCastingInfo" },
-- v2.8+ - DBC data access
["GetSpellRec"] = { 2, 8, 0, "GetSpellRec" },
["GetSpellRecField"] = { 2, 8, 0, "GetSpellRecField" },
["GetItemStats"] = { 2, 8, 0, "GetItemStats" },
["GetItemStatsField"] = { 2, 8, 0, "GetItemStatsField" },
["GetUnitData"] = { 2, 8, 0, "GetUnitData" },
["GetUnitField"] = { 2, 8, 0, "GetUnitField" },
["GetSpellModifiers"] = { 2, 8, 0, "GetSpellModifiers" },
-- v2.11+ - GetNampowerVersion itself (meta-feature)
["GetNampowerVersion"] = { 2, 11, 0, "GetNampowerVersion" },
-- v2.12+ - Enhanced spell functions and range/usable checks
["EnhancedSpellFunctions"] = { 2, 12, 0 }, -- No single function to verify
["IsSpellInRange"] = { 2, 12, 0, "IsSpellInRange" },
["IsSpellUsable"] = { 2, 12, 0, "IsSpellUsable" },
["GetSpellIdForName"] = { 2, 12, 0, "GetSpellIdForName" },
["GetSpellNameAndRankForId"]= { 2, 12, 0, "GetSpellNameAndRankForId" },
["GetSpellSlotTypeIdForName"]={ 2, 12, 0, "GetSpellSlotTypeIdForName" },
["CastSpellByNameNoQueue"] = { 2, 12, 0, "CastSpellByNameNoQueue" },
["QueueScript"] = { 2, 12, 0, "QueueScript" },
-- v2.13+ - QueueSpellByName with target parameter
["QueueSpellWithTarget"] = { 2, 13, 0 }, -- Same function, new parameter
-- v2.14+ - GetItemLevel standalone function
["GetItemLevel"] = { 2, 14, 0, "GetItemLevel" },
-- v2.18+ - Inventory, equipment, detailed cast/cooldown info
["FindPlayerItemSlot"] = { 2, 18, 0, "FindPlayerItemSlot" },
["GetEquippedItems"] = { 2, 18, 0, "GetEquippedItems" },
["GetEquippedItem"] = { 2, 18, 0, "GetEquippedItem" },
["GetBagItems"] = { 2, 18, 0, "GetBagItems" },
["GetBagItem"] = { 2, 18, 0, "GetBagItem" },
["GetCastInfo"] = { 2, 18, 0, "GetCastInfo" },
["GetSpellIdCooldown"] = { 2, 18, 0, "GetSpellIdCooldown" },
["GetItemIdCooldown"] = { 2, 18, 0, "GetItemIdCooldown" },
["ChannelStopCastingNextTick"]={ 2, 18, 0, "ChannelStopCastingNextTick" },
-- v2.20+ - Trinket API, item usage, copy parameter support, aura cast events
["GetTrinkets"] = { 2, 20, 0, "GetTrinkets" },
["GetTrinketCooldown"] = { 2, 20, 0, "GetTrinketCooldown" },
["UseTrinket"] = { 2, 20, 0, "UseTrinket" },
["UseItemIdOrName"] = { 2, 20, 0, "UseItemIdOrName" },
["CopyParameter"] = { 2, 20, 0 }, -- Table copy support
["AuraCastEvents"] = { 2, 20, 0 }, -- AURA_CAST_ON_SELF/OTHER events
-- v2.22+ - Utility functions
["DisenchantAll"] = { 2, 22, 0, "DisenchantAll" },
-- v2.23+ - Enhanced bag queries, cooldown item metadata
["GetBagItemsWithIndex"] = { 2, 23, 0 }, -- GetBagItems(bagIndex) parameter
["CooldownItemMetadata"] = { 2, 23, 0 }, -- itemId, itemHasActiveSpell, itemActiveSpellId
-- v2.24+ - Auto-attack events
["AutoAttackEvents"] = { 2, 24, 0 }, -- AUTO_ATTACK_SELF/OTHER events
-- v2.25+ - Spell start/go/failed/delayed/channel events
["SpellStartEvents"] = { 2, 25, 0 }, -- SPELL_START_SELF/OTHER events
["SpellGoEvents"] = { 2, 25, 0 }, -- SPELL_GO_SELF/OTHER events
["SpellFailedEvents"] = { 2, 25, 0 }, -- SPELL_FAILED_SELF/OTHER events
["SpellDelayedEvents"] = { 2, 25, 0 }, -- SPELL_DELAYED_SELF/OTHER events (OTHER does not fire; server only sends to affected player)
["SpellChannelEvents"] = { 2, 25, 0 }, -- SPELL_CHANNEL_START / SPELL_CHANNEL_UPDATE events (self-only)
-- v2.26+ - Spell heal/energize events
["SpellHealEvents"] = { 2, 26, 0 }, -- SPELL_HEAL_BY_SELF/OTHER/ON_SELF events
["SpellEnergizeEvents"] = { 2, 26, 0 }, -- SPELL_ENERGIZE_BY_SELF/OTHER/ON_SELF events
-- v2.27+ - Texture lookup functions
["GetItemIconTexture"] = { 2, 27, 0, "GetItemIconTexture" },
["GetSpellIconTexture"] = { 2, 27, 0, "GetSpellIconTexture" },
-- v2.28+ - Nameplate GUID via CSimpleFrame:GetName(1)
["NameplateGUID"] = { 2, 28, 0 },
-- v2.29+ - Ammo query
["GetAmmo"] = { 2, 29, 0, "GetAmmo" },
-- v2.30+ - Aura slot extensions
["AuraSlotParameter"] = { 2, 30, 0 },
["AuraDurationEvents"] = { 2, 30, 0 },
["GetPlayerAuraDuration"] = { 2, 30, 0, "GetPlayerAuraDuration" },
-- v2.31+ - Spell miss events
["SpellMissEvents"] = { 2, 31, 0 }, -- SPELL_MISS_SELF/OTHER events
-- v2.32+ - Aura event state parameter and stack removal fix
["AuraEventState"] = { 2, 32, 0 },
-- v2.33+ - UPDATE_DURATION spellId parameter and GetCastInfo guid fix
["DurationEventSpellId"] = { 2, 33, 0 },
["GetCastInfoGuidFix"] = { 2, 33, 0 },
-- v2.34+ - Aura cancel functions
["CancelPlayerAuraSlot"] = { 2, 34, 0, "CancelPlayerAuraSlot" },
["CancelPlayerAuraSpellId"] = { 2, 34, 0, "CancelPlayerAuraSpellId" },
-- v2.35+ - GUID string fix and talent helper
["GuidStringFormat"] = { 2, 35, 0 }, -- GetUnitData/GetUnitField return GUID fields as hex strings
["LearnTalentRank"] = { 2, 35, 0, "LearnTalentRank" },
-- v2.36+ - Player state functions
["PlayerIsMoving"] = { 2, 36, 0, "PlayerIsMoving" },
["PlayerIsRooted"] = { 2, 36, 0, "PlayerIsRooted" },
["PlayerIsSwimming"] = { 2, 36, 0, "PlayerIsSwimming" },
-- v2.37+ - Unit token cast support and SetMouseoverUnit
["CastSpellByNameUnitToken"]= { 2, 37, 0 }, -- CastSpellByName accepts unit token strings as 2nd param
["SetMouseoverUnit"] = { 2, 37, 0, "SetMouseoverUnit" },
-- v2.38+ - GetSpellDuration and enhanced SPELL_START parameters
["GetSpellDuration"] = { 2, 38, 0, "GetSpellDuration" },
["SpellStartSpellType"] = { 2, 38, 0 }, -- duration + spellType params added to SPELL_START events
-- v2.39+ - Unit GUID events and granular unit event CVars
["UnitGuidEvents"] = { 2, 39, 0 }, -- UNIT_HEALTH_GUID, UNIT_MANA_GUID, etc.
["UnitCombatGuid"] = { 2, 39, 0 }, -- UNIT_COMBAT_GUID event
["UnitEventGranularControl"]= { 2, 39, 0 }, -- NP_EnableUnitEvents* CVars
-- v2.40+ - Corpse GUID param in spell events and packed GUID fix
["SpellStartCorpseParam"] = { 2, 40, 0 }, -- arg9=corpseOwnerGuid added to SPELL_START events
["SpellGoCorpseParam"] = { 2, 40, 0 }, -- arg8=corpseOwnerGuid added to SPELL_GO events
["PackedGuidFix"] = { 2, 40, 0 }, -- Fix for packed GUID parsing (target showed as 0x000000000)
-- v2.41+ - Keyboard events and extended unit token support
["KeyEvents"] = { 2, 41, 0 }, -- KEY_DOWN / KEY_UP events (keyboard input events)
["ExtendedUnitTokens"] = { 2, 41, 0 }, -- Internal unit token resolution now supports "owner"/"target"/"pet"/"mark" in all Nampower functions (SetMouseoverUnit, UseItemIdOrName, etc.)
-- v3.0+ - GetUnitGUID rename, IsAuraHidden, hidden aura luaSlot fix
["GetUnitGUID"] = { 3, 0, 0, "GetUnitGUID" },
["IsAuraHidden"] = { 3, 0, 0, "IsAuraHidden" },
["HiddenAuraLuaSlotFix"] = { 3, 0, 0 },
-- v3.1+ - CastSpellNoQueue by ID, SPELL_CAST_EVENT target default
["CastSpellNoQueue"] = { 3, 1, 0, "CastSpellNoQueue" }, -- Cast by spell ID without queueing; accepts optional unit token
["SpellCastEventDefaultTarget"] = { 3, 1, 0 }, -- SPELL_CAST_EVENT targetGuid now defaults to current target instead of null GUID
-- v3.2+ - File I/O, combat log flush, encrypted login (GlueXML), backwards-compatible import/export
["WriteCustomFile"] = { 3, 2, 0, "WriteCustomFile" },
["ReadCustomFile"] = { 3, 2, 0, "ReadCustomFile" },
["CustomFileExists"] = { 3, 2, 0, "CustomFileExists" },
["ExecuteCustomLuaFile"] = { 3, 2, 0, "ExecuteCustomLuaFile" },
["ImportFile"] = { 3, 2, 0, "ImportFile" },
["ExportFile"] = { 3, 2, 0, "ExportFile" },
["CombatLogFlush"] = { 3, 2, 0, "CombatLogFlush" },
-- v3.3+ - Chat bubble controls, demon autocast reaction state preservation
["ChatBubbleControls"] = { 3, 3, 0 }, -- NP_ChatBubbleDistance, NP_ChatBubblesWhisper, NP_ChatBubblesRaid, NP_ChatBubblesBattleground
["DemonAutocastReactions"] = { 3, 3, 0 }, -- NP_PreserveGreaterDemonAutocast now saves/restores reaction states including infernal
-- v3.4+ - Environmental damage, damage shield, dispel events
["EnvironmentalDmgEvents"] = { 3, 4, 0 }, -- ENVIRONMENTAL_DMG_SELF/OTHER events
["DamageShieldEvents"] = { 3, 4, 0 }, -- DAMAGE_SHIELD_SELF/OTHER events
["SpellDispelEvents"] = { 3, 4, 0 }, -- SPELL_DISPEL_BY_SELF/OTHER events
-- v4.0+ - GetSpellRangeData, GUID event init fix
["GetSpellRangeData"] = { 4, 0, 0, "GetSpellRangeData" },
["GuidEventInitFix"] = { 4, 0, 0 }, -- _GUID events now work with old perf_boost (hooks initialized later)
-- v4.1+ - Revert PvP unit data restrictions from v4.0
["PvpUnitDataRevert"] = { 4, 1, 0 }, -- GetUnitData/GetUnitField no longer restricted for PvP-flagged units; BUFF/DEBUFF events restored
}
-- Check if a specific feature is available
-- Uses both version check AND function existence verification
function API.HasFeature(featureName)
local req = API.VERSION_REQUIREMENTS[featureName]
if not req then
return false
end
-- Check version requirement
if not API.HasMinimumVersion(req[1], req[2], req[3]) then
return false
end
-- If a global function is specified, verify it exists
if req[4] then
return _G[req[4]] ~= nil
end
return true
end
-- Get the minimum version required for a feature
-- Returns major, minor, patch or nil if feature unknown
function API.GetFeatureVersion(featureName)
local req = API.VERSION_REQUIREMENTS[featureName]
if req then
return req[1], req[2], req[3]
end
return nil
end
-- Feature flags (populated during initialization)
-- These provide quick boolean lookups after init
API.features = {}
-- Initialize all feature flags based on version detection
local function InitializeFeatures()
local f = API.features
-- Initialize version cache first
API.GetVersion()
-- Base Nampower detection (v2.0+)
f.hasNampower = API.HasFeature("SpellQueue")
f.hasSpellQueue = f.hasNampower
f.hasGetCurrentCastingInfo = API.HasFeature("GetCurrentCastingInfo")
-- v2.8+ DBC data access
f.hasGetSpellRec = API.HasFeature("GetSpellRec")
f.hasGetSpellRecField = API.HasFeature("GetSpellRecField")
f.hasGetItemStats = API.HasFeature("GetItemStats")
f.hasGetItemStatsField = API.HasFeature("GetItemStatsField")
f.hasGetUnitData = API.HasFeature("GetUnitData")
f.hasGetUnitField = API.HasFeature("GetUnitField")
f.hasGetSpellModifiers = API.HasFeature("GetSpellModifiers")
-- v2.11+ GetNampowerVersion
f.hasGetNampowerVersion = API.HasFeature("GetNampowerVersion")
-- v2.12+ Enhanced spell functions
f.hasEnhancedSpellFunctions = API.HasFeature("EnhancedSpellFunctions")
f.hasIsSpellInRange = API.HasFeature("IsSpellInRange")
f.hasIsSpellUsable = API.HasFeature("IsSpellUsable")
f.hasGetSpellIdForName = API.HasFeature("GetSpellIdForName")
f.hasGetSpellNameAndRankForId = API.HasFeature("GetSpellNameAndRankForId")
f.hasGetSpellSlotTypeIdForName = API.HasFeature("GetSpellSlotTypeIdForName")
f.hasCastSpellByNameNoQueue = API.HasFeature("CastSpellByNameNoQueue")
f.hasQueueScript = API.HasFeature("QueueScript")
-- v2.13+ QueueSpellByName with target
f.hasQueueSpellWithTarget = API.HasFeature("QueueSpellWithTarget")
-- v2.14+ GetItemLevel
f.hasGetItemLevel = API.HasFeature("GetItemLevel")
-- v2.18+ Inventory/Equipment/Cast info
f.hasFindPlayerItemSlot = API.HasFeature("FindPlayerItemSlot")
f.hasGetEquippedItems = API.HasFeature("GetEquippedItems")
f.hasGetEquippedItem = API.HasFeature("GetEquippedItem")
f.hasGetBagItems = API.HasFeature("GetBagItems")
f.hasGetBagItem = API.HasFeature("GetBagItem")
f.hasGetCastInfo = API.HasFeature("GetCastInfo")
f.hasGetSpellIdCooldown = API.HasFeature("GetSpellIdCooldown")
f.hasGetItemIdCooldown = API.HasFeature("GetItemIdCooldown")
f.hasChannelStopCastingNextTick = API.HasFeature("ChannelStopCastingNextTick")
-- v2.20+ Trinket/Item API and Aura Cast Events
f.hasGetTrinkets = API.HasFeature("GetTrinkets")
f.hasGetTrinketCooldown = API.HasFeature("GetTrinketCooldown")
f.hasUseTrinket = API.HasFeature("UseTrinket")
f.hasUseItemIdOrName = API.HasFeature("UseItemIdOrName")
f.hasCopyParameter = API.HasFeature("CopyParameter")
f.hasAuraCastEvents = API.HasFeature("AuraCastEvents")
-- v2.22+ Utility functions
f.hasDisenchantAll = API.HasFeature("DisenchantAll")
-- v2.23+ Enhanced features
f.hasGetBagItemsWithIndex = API.HasFeature("GetBagItemsWithIndex")
f.hasCooldownItemMetadata = API.HasFeature("CooldownItemMetadata")
-- v2.24+ Auto-attack events
f.hasAutoAttackEvents = API.HasFeature("AutoAttackEvents")
-- v2.25+ Spell start/go/failed/delayed/channel events
f.hasSpellStartEvents = API.HasFeature("SpellStartEvents")
f.hasSpellGoEvents = API.HasFeature("SpellGoEvents")
f.hasSpellFailedEvents = API.HasFeature("SpellFailedEvents")
f.hasSpellDelayedEvents = API.HasFeature("SpellDelayedEvents")
f.hasSpellChannelEvents = API.HasFeature("SpellChannelEvents")
-- v2.26+ Spell heal/energize events
f.hasSpellHealEvents = API.HasFeature("SpellHealEvents")
f.hasSpellEnergizeEvents = API.HasFeature("SpellEnergizeEvents")
-- v2.27+ Texture lookup functions
f.hasGetItemIconTexture = API.HasFeature("GetItemIconTexture")
f.hasGetSpellIconTexture = API.HasFeature("GetSpellIconTexture")
-- v2.28+ Nameplate GUID
f.hasNameplateGUID = API.HasFeature("NameplateGUID")
-- v2.29+ Ammo query
f.hasGetAmmo = API.HasFeature("GetAmmo")
-- v2.30+ Aura slot extensions
f.hasAuraSlotParameter = API.HasFeature("AuraSlotParameter")
f.hasAuraDurationEvents = API.HasFeature("AuraDurationEvents")
f.hasGetPlayerAuraDuration = API.HasFeature("GetPlayerAuraDuration")
-- v2.31+ Spell miss events
f.hasSpellMissEvents = API.HasFeature("SpellMissEvents")
-- v2.32+ Aura event state parameter
f.hasAuraEventState = API.HasFeature("AuraEventState")
-- v2.33+ Duration event spellId and GetCastInfo guid fix
f.hasDurationEventSpellId = API.HasFeature("DurationEventSpellId")
f.hasGetCastInfoGuidFix = API.HasFeature("GetCastInfoGuidFix")
-- v2.34+ Aura cancel functions
f.hasCancelPlayerAuraSlot = API.HasFeature("CancelPlayerAuraSlot")
f.hasCancelPlayerAuraSpellId = API.HasFeature("CancelPlayerAuraSpellId")
-- v2.35+ GUID string format and talent helper
f.hasGuidStringFormat = API.HasFeature("GuidStringFormat")
f.hasLearnTalentRank = API.HasFeature("LearnTalentRank")
-- v2.36+ Player state functions
f.hasPlayerIsMoving = API.HasFeature("PlayerIsMoving")
f.hasPlayerIsRooted = API.HasFeature("PlayerIsRooted")
f.hasPlayerIsSwimming = API.HasFeature("PlayerIsSwimming")
-- v2.37+ Unit token cast support and SetMouseoverUnit
f.hasCastSpellByNameUnitToken = API.HasFeature("CastSpellByNameUnitToken")
f.hasSetMouseoverUnit = API.HasFeature("SetMouseoverUnit")
-- v2.38+ GetSpellDuration and enhanced SPELL_START parameters
f.hasGetSpellDuration = API.HasFeature("GetSpellDuration")
f.hasSpellStartSpellType = API.HasFeature("SpellStartSpellType")
-- v2.39+ Unit GUID events and granular unit event CVars
f.hasUnitGuidEvents = API.HasFeature("UnitGuidEvents")
f.hasUnitCombatGuid = API.HasFeature("UnitCombatGuid")
f.hasUnitEventGranularControl = API.HasFeature("UnitEventGranularControl")
-- v2.40+ Corpse GUID param in spell events and packed GUID fix
f.hasSpellStartCorpseParam = API.HasFeature("SpellStartCorpseParam")
f.hasSpellGoCorpseParam = API.HasFeature("SpellGoCorpseParam")
f.hasPackedGuidFix = API.HasFeature("PackedGuidFix")
-- v2.41+ Keyboard events and extended unit token support
f.hasKeyEvents = API.HasFeature("KeyEvents")
f.hasExtendedUnitTokens = API.HasFeature("ExtendedUnitTokens")
-- v3.0+ GetUnitGUID, IsAuraHidden, hidden aura luaSlot fix
f.hasGetUnitGUID = API.HasFeature("GetUnitGUID")
f.hasIsAuraHidden = API.HasFeature("IsAuraHidden")
f.hasHiddenAuraLuaSlotFix = API.HasFeature("HiddenAuraLuaSlotFix")
-- v3.1+ CastSpellNoQueue by ID, SPELL_CAST_EVENT default target
f.hasCastSpellNoQueue = API.HasFeature("CastSpellNoQueue")
f.hasSpellCastEventDefaultTarget = API.HasFeature("SpellCastEventDefaultTarget")
-- v3.2+ File I/O, combat log flush, backwards-compatible import/export
f.hasWriteCustomFile = API.HasFeature("WriteCustomFile")
f.hasReadCustomFile = API.HasFeature("ReadCustomFile")
f.hasCustomFileExists = API.HasFeature("CustomFileExists")
f.hasExecuteCustomLuaFile = API.HasFeature("ExecuteCustomLuaFile")
f.hasImportFile = API.HasFeature("ImportFile")
f.hasExportFile = API.HasFeature("ExportFile")
f.hasCombatLogFlush = API.HasFeature("CombatLogFlush")
-- v3.3+ Chat bubble controls, demon autocast enhancements
f.hasChatBubbleControls = API.HasFeature("ChatBubbleControls")
f.hasDemonAutocastReactions = API.HasFeature("DemonAutocastReactions")
-- v3.4+ Environmental damage, damage shield, dispel events
f.hasEnvironmentalDmgEvents = API.HasFeature("EnvironmentalDmgEvents")
f.hasDamageShieldEvents = API.HasFeature("DamageShieldEvents")
f.hasSpellDispelEvents = API.HasFeature("SpellDispelEvents")
-- v4.0+ GetSpellRangeData, GUID event init fix
f.hasGetSpellRangeData = API.HasFeature("GetSpellRangeData")
f.hasGuidEventInitFix = API.HasFeature("GuidEventInitFix")
-- v4.1+ Revert PvP unit data restrictions
f.hasPvpUnitDataRevert = API.HasFeature("PvpUnitDataRevert")
-- Runtime detection for enhanced spell functions (verify by testing)
if f.hasEnhancedSpellFunctions and GetSpellTexture then
local success, result = pcall(function()
return GetSpellTexture("Attack")
end)
f.hasEnhancedSpellFunctions = success and (result ~= nil)
end
end
-- Legacy function for compatibility (now just calls InitializeFeatures)
local function DetectEnhancedSpellFunctions()
return API.features.hasEnhancedSpellFunctions
end
-- Initialize features immediately on load
InitializeFeatures()
--------------------------------------------------------------------------------
-- NAMPOWER SETTINGS ACCESS
--------------------------------------------------------------------------------
-- Cache for settings to avoid repeated lookups
API.settingsCache = {}
API.settingsCacheTime = 0
API.SETTINGS_CACHE_DURATION = 5 -- Refresh every 5 seconds
-- All known Nampower CVars with their defaults
API.defaultSettings = {
NP_QueueCastTimeSpells = "1",
NP_QueueInstantSpells = "1",
NP_QueueChannelingSpells = "1",
NP_QueueTargetingSpells = "1",
NP_QueueOnSwingSpells = "0",
NP_QueueSpellsOnCooldown = "1",
NP_InterruptChannelsOutsideQueueWindow = "0",
NP_SpellQueueWindowMs = "500",
NP_OnSwingBufferCooldownMs = "500",
NP_ChannelQueueWindowMs = "1500",
NP_TargetingQueueWindowMs = "500",
NP_CooldownQueueWindowMs = "250",
NP_MinBufferTimeMs = "55",
NP_NonGcdBufferTimeMs = "100",
NP_MaxBufferIncreaseMs = "30",
NP_RetryServerRejectedSpells = "1",
NP_QuickcastTargetingSpells = "0",
NP_QuickcastOnDoubleCast = "0", -- v2.18+: cast targeting spells by double-casting
NP_ReplaceMatchingNonGcdCategory = "0",
NP_OptimizeBufferUsingPacketTimings = "0",
NP_PreventRightClickTargetChange = "0",
NP_PreventRightClickPvPAttack = "1",
NP_DoubleCastToEndChannelEarly = "0",
NP_SpamProtectionEnabled = "1",
NP_ChannelLatencyReductionPercentage = "75",
NP_NameplateDistance = "41",
-- v2.20+ CVars
NP_PreventMountingWhenBuffCapped = "1", -- Prevent mounting when buff capped (32 buffs)
NP_EnableAuraCastEvents = "0", -- Enable AURA_CAST_ON_SELF/OTHER events
-- v2.24+ CVars
NP_EnableAutoAttackEvents = "0", -- Enable AUTO_ATTACK_SELF/OTHER events
-- v2.25+ CVars
NP_EnableSpellStartEvents = "0", -- Enable SPELL_START_SELF/OTHER events
NP_EnableSpellGoEvents = "0", -- Enable SPELL_GO_SELF/OTHER events
-- v2.26+ CVars
NP_EnableSpellHealEvents = "0", -- Enable SPELL_HEAL_BY_SELF/OTHER/ON_SELF events
NP_EnableSpellEnergizeEvents = "0", -- Enable SPELL_ENERGIZE_BY_SELF/OTHER/ON_SELF events
-- v2.39+ CVars
NP_EnableUnitEventsPet = "1", -- Fire unit events for pet/partypet1-4 tokens
NP_EnableUnitEventsParty = "1", -- Fire unit events for party1-4 tokens
NP_EnableUnitEventsRaid = "1", -- Fire unit events for raid1-40 tokens
NP_EnableUnitEventsMouseover = "1", -- Fire unit events for mouseover token
NP_EnableUnitEventsGuid = "1", -- Fire UNIT_* events using raw GUID as unit token (mimics SuperWoW)
NP_EnableUnitEventsGuidFiltering = "1", -- Suppress high-freq raw GUID events that have _GUID variants
-- v3.1+ CVars
NP_PreserveGreaterDemonAutocast = "1", -- Remember/restore greater demon autocast preferences (v3.3+: also saves reaction states incl. infernal)
-- v3.3+ CVars
NP_ChatBubbleDistance = "60", -- Max distance for chat bubbles
NP_ChatBubblesWhisper = "0", -- Show chat bubbles for whispers
NP_ChatBubblesRaid = "0", -- Show chat bubbles for raid leader/warning
NP_ChatBubblesBattleground = "0", -- Show chat bubbles for battleground chat
}
-- Get a Nampower setting value
-- Priority: NampowerSettings addon (per-character) > CVar > default
function API.GetSetting(settingName)
-- Check if NampowerSettings addon is loaded and has per-character settings enabled
if Nampower and Nampower.db and Nampower.db.profile then
if Nampower.db.profile.per_character_settings and Nampower.db.profile[settingName] ~= nil then
return Nampower.db.profile[settingName]
end
end
-- Fall back to CVar
local cvarValue = GetCVar(settingName)
if cvarValue then
return cvarValue
end
-- Return default if known
return API.defaultSettings[settingName]
end
-- Get a Nampower setting as a boolean
function API.GetSettingBool(settingName)
local value = API.GetSetting(settingName)
if type(value) == "boolean" then
return value
end
return value == "1" or value == true
end
-- Get a Nampower setting as a number
function API.GetSettingNumber(settingName)
local value = API.GetSetting(settingName)
return tonumber(value) or 0
end
-- Check if spell queuing is enabled for a given spell type
function API.IsQueueingEnabled(spellType)
if not API.features.hasNampower then
return false
end
if spellType == "cast" or spellType == "casttime" then
return API.GetSettingBool("NP_QueueCastTimeSpells")
elseif spellType == "instant" or spellType == "gcd" then
return API.GetSettingBool("NP_QueueInstantSpells")
elseif spellType == "channel" or spellType == "channeling" then
return API.GetSettingBool("NP_QueueChannelingSpells")
elseif spellType == "targeting" or spellType == "aoe" then
return API.GetSettingBool("NP_QueueTargetingSpells")
elseif spellType == "onswing" or spellType == "swing" then
return API.GetSettingBool("NP_QueueOnSwingSpells")
elseif spellType == "cooldown" then
return API.GetSettingBool("NP_QueueSpellsOnCooldown")
end
-- Default: all queuing enabled
return API.GetSettingBool("NP_QueueCastTimeSpells")
end
-- Check if ANY spell queuing is enabled
function API.IsAnyQueueingEnabled()
if not API.features.hasNampower then
return false
end
-- Check all spell type queuing settings
return API.GetSettingBool("NP_QueueCastTimeSpells")
or API.GetSettingBool("NP_QueueInstantSpells")
or API.GetSettingBool("NP_QueueChannelingSpells")
or API.GetSettingBool("NP_QueueOnSwingSpells")
end
-- Get the queue window for a given spell type (in seconds)
function API.GetQueueWindow(spellType)
local ms = 500 -- default
if spellType == "channel" or spellType == "channeling" then
ms = API.GetSettingNumber("NP_ChannelQueueWindowMs")
elseif spellType == "targeting" or spellType == "aoe" then
ms = API.GetSettingNumber("NP_TargetingQueueWindowMs")
elseif spellType == "cooldown" then
ms = API.GetSettingNumber("NP_CooldownQueueWindowMs")
elseif spellType == "onswing" or spellType == "swing" then
ms = API.GetSettingNumber("NP_OnSwingBufferCooldownMs")
else
ms = API.GetSettingNumber("NP_SpellQueueWindowMs")
end
return ms / 1000 -- Convert to seconds
end
--------------------------------------------------------------------------------
-- SPELL RECORD API (GetSpellRec / GetSpellRecField)
--------------------------------------------------------------------------------
-- Cache for spell records
API.spellRecCache = {}
-- Get full spell record data
-- Returns nil if spell not found or API unavailable (requires v2.8+)
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
-- WARNING: Without copy, table references are reused - extract values immediately!
function API.GetSpellRecord(spellId, copy)
if not spellId or spellId == 0 then return nil end
-- Requires v2.8+ for GetSpellRec
if not API.features.hasGetSpellRec then
return nil
end
-- Check cache first (only for non-copy requests)
if not copy and API.spellRecCache[spellId] then
return API.spellRecCache[spellId]
end
-- Copy parameter requires v2.20+
-- When caching (not copy), also request copy=1 if available for safe storage
-- This prevents issues with Nampower's table reuse
local useCopy = nil
if API.features.hasCopyParameter then
useCopy = copy or 1 -- Use caller's copy value, or 1 for caching
end
-- Use native function
if GetSpellRec then
local rec = GetSpellRec(spellId, useCopy)
if rec then
if not copy then
API.spellRecCache[spellId] = rec
end
return rec
end
end
return nil
end
-- Get a specific field from spell record
-- Returns nil if not found (requires v2.8+)
-- Pass copy=1 to get an independent copy for array fields (v2.20+)
function API.GetSpellField(spellId, fieldName, copy)
if not spellId or spellId == 0 then return nil end
-- Requires v2.8+ for GetSpellRecField
if not API.features.hasGetSpellRecField then
return nil
end
-- Copy parameter requires v2.20+
local useCopy = copy and API.features.hasCopyParameter and copy or nil
-- Use native function (more efficient for single field)
if GetSpellRecField then
local success, result = pcall(GetSpellRecField, spellId, fieldName, useCopy)
if success then
return result
end
return nil
end
-- Fallback to full record lookup
local rec = API.GetSpellRecord(spellId, copy)
if rec then
return rec[fieldName]
end
return nil
end
-- Get spell name by ID (enhanced, uses new API when available)
function API.GetSpellNameById(spellId)
if not spellId or spellId == 0 then return nil end
-- Try GetSpellNameAndRankForId first (Nampower function)
if GetSpellNameAndRankForId then
local name, rank = GetSpellNameAndRankForId(spellId)
if name then return name, rank end
end
-- Fall back to GetSpellRecField
if GetSpellRecField then
local name = GetSpellRecField(spellId, "name")
local rank = GetSpellRecField(spellId, "rank")
if name then return name, rank end
end
return nil
end
-- Get spell cast time in seconds
function API.GetSpellCastTime(spellId)
local castTime = API.GetSpellField(spellId, "castTime")
if castTime then
return castTime / 1000 -- Convert from ms to seconds
end
return nil
end
-- Get spell school (0=Physical, 1=Holy, 2=Fire, 3=Nature, 4=Frost, 5=Shadow, 6=Arcane)
function API.GetSpellSchool(spellId)
return API.GetSpellField(spellId, "school")
end
-- Get spell mana cost
function API.GetSpellManaCost(spellId)
return API.GetSpellField(spellId, "manaCost")
end
-- SpellRange.dbc lookup table: rangeIndex -> maxRange (in yards)
-- From vanilla 1.12.1 client data (corrected based on actual spell ranges)
API.SpellRangeTable = {
[0] = 0, -- Self Only
[1] = 5, -- Combat Range (Melee)
[2] = 30, -- 30 yard range (Frostbolt, etc.)
[3] = 35, -- 35 yard range
[4] = 30, -- 30 yard range (Arcane Missiles, etc.)
[5] = 40, -- 40 yard range
[6] = 45, -- 45 yard range
[7] = 100, -- Vision Range
[8] = 20, -- 20 yard range
[9] = 10, -- 10 yard range
[10] = 8, -- 8 yard range
[11] = 15, -- 15 yard range (Charge)
[12] = 25, -- 25 yard range
[13] = 100, -- Anywhere/Unlimited
[14] = 0, -- Self Only (alternate)
[15] = 80, -- 80 yard range (hunters)
[16] = 18, -- 18 yard range
[17] = 60, -- 60 yard range
[18] = 5, -- Melee (alternate)
[19] = 25, -- 25 yard range (alternate)
[20] = 30, -- 30 yard range (alternate)
[21] = 35, -- 35 yard range (alternate)
[22] = 40, -- 40 yard range (alternate)
[23] = 0, -- Touch
[24] = 41, -- 41 yard range
[25] = 10, -- 10 yard range (alternate)
[26] = 50, -- 50 yard range
[27] = 55, -- 55 yard range
[28] = 65, -- 65 yard range
[29] = 70, -- 70 yard range
[30] = 50000, -- Unlimited
[31] = 8, -- 8 yard range (alternate)
[32] = 7, -- 7 yard range
[33] = 11, -- 11 yard range
[34] = 12, -- 12 yard range
[35] = 28, -- 28 yard range
[36] = 6, -- 6 yard range
[37] = 13, -- 13 yard range
[38] = 15, -- 15 yard range (alternate)
[39] = 100, -- 100 yard range (alternate)
[40] = 150, -- 150 yard range
}
-- Unit target types that require distance checking (from DBC)
-- These target OTHER units, not self - so distance matters
-- Excludes TARGET_UNIT_CASTER (1) which is self-cast and always in range
local UNIT_TARGET_TYPES_NEED_RANGE = {
[5] = true, -- TARGET_UNIT_PET
[6] = true, -- TARGET_UNIT_TARGET_ENEMY
[21] = true, -- TARGET_UNIT_TARGET_ALLY
[22] = true, -- TARGET_UNIT_PARTY
[23] = true, -- TARGET_UNIT_PARTY_AROUND_CASTER
[25] = true, -- TARGET_UNIT_PET (alternate)
[38] = true, -- TARGET_UNIT_TARGET_ANY
}
-- Helper to check a target value or array for unit targeting
local function checkTargetForUnitType(target)
if not target then return nil end
-- If it's a table (array of 3 effect targets), check each element
if type(target) == "table" then
for i = 1, 3 do
local val = target[i]
if val and UNIT_TARGET_TYPES_NEED_RANGE[val] then
return true -- Found a unit-targeting effect
end
end
-- Check if any element has a value (even if not unit-targeting)
for i = 1, 3 do
if target[i] and target[i] ~= 0 then
return false -- Has target data but not unit-targeting
end
end
return nil
end
-- If it's a number, check directly
if type(target) == "number" then
if UNIT_TARGET_TYPES_NEED_RANGE[target] then
return true
end
if target ~= 0 then
return false -- Has target data but not unit-targeting
end
end
return nil
end
-- Check if a spell requires distance checking to another unit
-- Returns true if the spell targets other units (needs range check)
-- Returns false if self-cast, ground-targeted, or area effect (always "in range")
-- Returns nil if unknown
function API.IsUnitTargetedSpell(spellId)
if not spellId or spellId == 0 then return nil end
-- Check effectImplicitTargetA
local targetA = API.GetSpellField(spellId, "effectImplicitTargetA")
local resultA = checkTargetForUnitType(targetA)
if resultA == true then
return true -- Targets other units, needs range check
end
-- Also check targetB
local targetB = API.GetSpellField(spellId, "effectImplicitTargetB")
local resultB = checkTargetForUnitType(targetB)
if resultB == true then
return true -- Targets other units, needs range check
end
-- If either returned false (has data but not unit-targeting), spell doesn't need range check
if resultA == false or resultB == false then
return false
end
return nil -- Unknown
end
-- Get spell range (max range in yards)
function API.GetSpellRange(spellId)
if not spellId or spellId == 0 then return nil end
local rangeIndex = API.GetSpellField(spellId, "rangeIndex")
if rangeIndex then
-- Prefer GetSpellRangeData (v4.0+) for runtime DBC lookup (covers custom ranges)
if API.features.hasGetSpellRangeData and _G.GetSpellRangeData then
local minRange, maxRange, flags, name = _G.GetSpellRangeData(rangeIndex)
if maxRange and maxRange > 0 then
return maxRange
end
end
-- Fallback: hardcoded SpellRange table
local range = API.SpellRangeTable[rangeIndex]
if range then
return range
end
end
return nil
end
-- Get spell cooldown from record (base cooldown, not current)
function API.GetSpellBaseCooldown(spellId)
local recoveryTime = API.GetSpellField(spellId, "recoveryTime")
if recoveryTime then
return recoveryTime / 1000 -- Convert from ms to seconds
end
return nil
end
--------------------------------------------------------------------------------
-- ITEM STATS API (GetItemStats / GetItemStatsField)
--------------------------------------------------------------------------------
-- Cache for item stats
API.itemStatsCache = {}
-- Get full item stats data
-- Requires v2.8+ for GetItemStats
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
-- WARNING: Without copy, table references are reused - extract values immediately!
function API.GetItemRecord(itemId, copy)
if not itemId or itemId == 0 then return nil end
-- Requires v2.8+ for GetItemStats
if not API.features.hasGetItemStats then
return nil
end
-- Check cache first (only for non-copy requests)
if not copy and API.itemStatsCache[itemId] then
return API.itemStatsCache[itemId]
end
-- Copy parameter requires v2.20+
-- When caching (not copy), also request copy=1 if available for safe storage
-- This prevents issues with Nampower's table reuse
local useCopy = nil
if API.features.hasCopyParameter then
useCopy = copy or 1 -- Use caller's copy value, or 1 for caching
end
-- Use native function
if GetItemStats then
local ok, stats = pcall(GetItemStats, itemId, useCopy)
if ok and stats then
if not copy then
API.itemStatsCache[itemId] = stats
end
return stats
end
end
return nil
end
-- Get a specific field from item stats
-- Requires v2.8+ for GetItemStatsField
-- Pass copy=1 to get an independent copy for array fields (v2.20+)
function API.GetItemField(itemId, fieldName, copy)
if not itemId or itemId == 0 then return nil end
-- Requires v2.8+ for GetItemStatsField
if not API.features.hasGetItemStatsField then
return nil
end
-- Copy parameter requires v2.20+
local useCopy = copy and API.features.hasCopyParameter and copy or nil
-- Use native function (more efficient)
if GetItemStatsField then
local success, result = pcall(GetItemStatsField, itemId, fieldName, useCopy)
if success then
return result
end
return nil
end
-- Fallback to full record lookup
local stats = API.GetItemRecord(itemId, copy)
if stats then
return stats[fieldName]
end
return nil
end
-- Get item level
-- Uses standalone GetItemLevel (v2.14+) or falls back to GetItemStatsField (v2.8+)
function API.GetItemLevel(itemId)
-- Use dedicated function if available (v2.14+)
if API.features.hasGetItemLevel and GetItemLevel then
local success, result = pcall(GetItemLevel, itemId)
if success then return result end
end
-- Fallback to GetItemField (v2.8+)
return API.GetItemField(itemId, "itemLevel")
end
-- Get item name
function API.GetItemName(itemId)
return API.GetItemField(itemId, "displayName")
end
-- Get item quality (0=Poor, 1=Common, 2=Uncommon, 3=Rare, 4=Epic, 5=Legendary)
function API.GetItemQuality(itemId)
return API.GetItemField(itemId, "quality")
end
-- Get weapon speed in seconds
function API.GetWeaponSpeed(itemId)
local delay = API.GetItemField(itemId, "delay")
if delay then
return delay / 1000
end
return nil
end
-- Get item inventory type (equipment slot)
-- Returns: inventoryType number, or nil if not equippable
-- Common types: 0=Non-equip, 1=Head, 2=Neck, 3=Shoulder, 4=Shirt, 5=Chest,
-- 6=Waist, 7=Legs, 8=Feet, 9=Wrist, 10=Hands, 11=Finger, 12=Trinket,
-- 13=One-Hand, 14=Shield, 15=Ranged, 16=Back, 17=Two-Hand,
-- 18=Bag, 20=Robe, 21=Main Hand, 22=Off Hand, 23=Holdable,
-- 24=Ammo, 25=Thrown, 26=Ranged Right, 28=Relic
function API.GetItemInventoryType(itemId)
local ok, result = pcall(API.GetItemField, itemId, "inventoryType")
if ok then return result end
return nil
end
-- Convert inventoryType to equipment slot ID(s)
-- Returns slotId, altSlotId (for rings/trinkets)
API.inventoryTypeToSlot = {
[1] = 1, -- Head -> HeadSlot
[2] = 2, -- Neck -> NeckSlot
[3] = 3, -- Shoulder -> ShoulderSlot
[4] = 4, -- Shirt -> ShirtSlot
[5] = 5, -- Chest -> ChestSlot
[6] = 6, -- Waist -> WaistSlot
[7] = 7, -- Legs -> LegsSlot
[8] = 8, -- Feet -> FeetSlot
[9] = 9, -- Wrist -> WristSlot
[10] = 10, -- Hands -> HandsSlot
[11] = {11, 12}, -- Finger -> Finger0Slot or Finger1Slot
[12] = {13, 14}, -- Trinket -> Trinket0Slot or Trinket1Slot
[13] = 16, -- One-Hand -> MainHandSlot (can also go off-hand)
[14] = 17, -- Shield -> SecondaryHandSlot
[15] = 18, -- Ranged -> RangedSlot
[16] = 15, -- Back -> BackSlot
[17] = 16, -- Two-Hand -> MainHandSlot
[20] = 5, -- Robe -> ChestSlot
[21] = 16, -- Main Hand -> MainHandSlot
[22] = 17, -- Off Hand -> SecondaryHandSlot
[23] = 17, -- Holdable -> SecondaryHandSlot
[24] = 0, -- Ammo -> AmmoSlot
[25] = 18, -- Thrown -> RangedSlot
[26] = 18, -- Ranged Right -> RangedSlot
[28] = 18, -- Relic -> RangedSlot
}
-- Get equipment slot ID for an item
-- Returns slotId, altSlotId for items that can go in multiple slots
function API.GetItemEquipSlot(itemId)
local ok, invType = pcall(API.GetItemInventoryType, itemId)
if not ok or not invType or invType == 0 then return nil end
local slotInfo = API.inventoryTypeToSlot[invType]
if type(slotInfo) == "table" then
return slotInfo[1], slotInfo[2] -- Primary and alt slot
end
return slotInfo, nil
end
--------------------------------------------------------------------------------
-- UNIT DATA API (GetUnitData / GetUnitField) - Requires v2.8+
--------------------------------------------------------------------------------
-- Get full unit data (no caching - unit data changes frequently)
-- Requires v2.8+ for GetUnitData
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
-- WARNING: Without copy, table references are reused - extract values immediately!
function API.GetUnitRecord(unitToken, copy)
if not unitToken then return nil end
-- Requires v2.8+ for GetUnitData
if not API.features.hasGetUnitData then
return nil
end
-- Copy parameter requires v2.20+
local useCopy = copy and API.features.hasCopyParameter and copy or nil
if GetUnitData then
return GetUnitData(unitToken, useCopy)
end
return nil
end
-- Get a specific unit field
-- Requires v2.8+ for GetUnitField
-- Pass copy=1 to get an independent copy for array fields (v2.20+)
function API.GetUnitFieldValue(unitToken, fieldName, copy)
if not unitToken then return nil end
-- Requires v2.8+ for GetUnitField
if not API.features.hasGetUnitField then
return nil
end
-- Copy parameter requires v2.20+
local useCopy = copy and API.features.hasCopyParameter and copy or nil
-- Use native function (more efficient)
if GetUnitField then
local success, result = pcall(GetUnitField, unitToken, fieldName, useCopy)
if success then
return result
end
return nil
end
-- Fallback to full record
local data = API.GetUnitRecord(unitToken, copy)
if data then
return data[fieldName]
end
return nil
end
-- Get unit's current auras as spell IDs
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
function API.GetUnitAuras(unitToken, copy)
return API.GetUnitFieldValue(unitToken, "aura", copy)
end
-- Get unit resistances table
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
function API.GetUnitResistances(unitToken, copy)
return API.GetUnitFieldValue(unitToken, "resistances", copy)
end
-- Get specific resistance value
-- school: 1=Armor, 2=Holy, 3=Fire, 4=Nature, 5=Frost, 6=Shadow, 7=Arcane
function API.GetUnitResistance(unitToken, school)
local resistances = API.GetUnitResistances(unitToken)
if resistances and school then
return resistances[school]
end
return nil
end
-- Check if unit has a specific aura by spell ID
function API.UnitHasAura(unitToken, spellId)
local auras = API.GetUnitAuras(unitToken)
if not auras or not spellId then return false end
for _, auraId in ipairs(auras) do
if auraId == spellId then
return true
end
end
return false
end
-- Get unit's aura stack counts (auraApplications field)
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
function API.GetUnitAuraApplications(unitToken, copy)
return API.GetUnitFieldValue(unitToken, "auraApplications", copy)
end
-- Composite helper: Search unit's auras for a spell by ID or lowercase name,
-- returning match info with stack count from auraApplications.
--
-- Parameters:
-- unitToken - Unit token (e.g., "target", "focus")
-- searchSpellId - Spell ID to match (number), or nil for name search
-- searchNameLower - Lowercase spell name to match (string), or nil for ID search
--
-- Returns:
-- nil - GetUnitField unavailable (caller should use slow path)
-- false - Searched but aura not found
-- true, matchedSpellId, stacks, slotIndex - Found; slotIndex 1-32 = buff, 33-48 = debuff
function API.FindUnitAuraInfo(unitToken, searchSpellId, searchNameLower)
if not unitToken then return nil end
if not searchSpellId and not searchNameLower then return nil end
local auras = API.GetUnitAuras(unitToken)
if not auras then return nil end -- GetUnitField unavailable
local applications = API.GetUnitAuraApplications(unitToken)
for i = 1, 48 do
local auraId = auras[i]
if auraId and auraId ~= 0 then
local matched = false
if searchSpellId then
matched = (auraId == searchSpellId)
elseif searchNameLower then
local name = GetSpellRecField and GetSpellRecField(auraId, "name")
if name then
-- Strip rank suffix for consistent matching
local baseName = CleveRoids.StripRank(name)
if string.lower(baseName) == searchNameLower then
matched = true
end
end
end
if matched then
-- auraApplications is 0-indexed (0 = 1 stack); convert to 1-indexed
local stacks = applications and (applications[i] or 0) + 1 or 0
return true, auraId, stacks, i
end
end
end
return false
end
--------------------------------------------------------------------------------
-- INVENTORY & EQUIPMENT API (v2.18+)
--------------------------------------------------------------------------------
-- Find an item in player's inventory by ID or name
-- Requires v2.18+ for native FindPlayerItemSlot (with Lua fallback)
-- Returns: bagIndex, slot (see wiki for bag index meanings)
-- bagIndex nil + slot = equipped item (slot is equipment slot 0-18)
-- bagIndex + slot = item in bag
-- nil, nil = item not found
function API.FindPlayerItemSlot(itemIdOrName)
if not itemIdOrName then return nil, nil end
-- Use native function if available (v2.18+)
if API.features.hasFindPlayerItemSlot and FindPlayerItemSlot then
return FindPlayerItemSlot(itemIdOrName)
end
-- Fallback: manual search for older versions
-- This is much slower but works without Nampower 2.18
local itemName = itemIdOrName
if type(itemIdOrName) == "number" then
-- Try to get item name from ID
itemName = API.GetItemName(itemIdOrName)
if not itemName then
-- Try GetItemInfo as fallback (only works for cached items)
itemName = GetItemInfo(itemIdOrName)
end
if not itemName then
return nil, nil -- Can't resolve item ID
end
end
-- Search equipped items first (WoW API uses 1-19 for inventory slots)
for slot = 1, 19 do
local link = GetInventoryItemLink("player", slot)
if link then
local name = GetItemInfo(link)
if name and string.lower(name) == string.lower(itemName) then
return nil, slot -- Equipped (1-indexed, matches Nampower behavior)
end
end
end
-- Search bags (0 = backpack, 1-4 = bags)
for bag = 0, 4 do
local numSlots = GetContainerNumSlots(bag)
for slot = 1, numSlots do
local link = GetContainerItemLink(bag, slot)
if link then
local name = GetItemInfo(link)
if name and string.lower(name) == string.lower(itemName) then
return bag, slot
end
end
end
end
return nil, nil -- Not found
end
-- Get all equipped items for a unit
-- Requires v2.18+ for native GetEquippedItems (with Lua fallback for player only)
-- Returns table with slot indices (1-19) as keys, item info tables as values
function API.GetEquippedItems(unitToken)
unitToken = unitToken or "player"
-- Use native function if available (v2.18+)
if API.features.hasGetEquippedItems and GetEquippedItems then
return GetEquippedItems(unitToken)
end
-- Fallback: manual lookup for player only
if unitToken ~= "player" then
return nil -- Can't inspect other units without native API
end
local items = {}
for slot = 1, 19 do
local itemId = CleveRoids.ClassicAPI.GetInventoryItemID("player", slot)
if itemId then
items[slot] = {
itemId = itemId,
-- Other fields not available without native API
}
end
end
return items
end
-- Get equipped item info for a specific slot
-- Requires v2.18+ for native GetEquippedItem (with Lua fallback for player only)
-- Slot numbers: 1=Head, 2=Neck, 3=Shoulder... 16=MainHand, 17=OffHand, 18=Ranged
function API.GetEquippedItem(unitToken, slot)
unitToken = unitToken or "player"
-- Use native function if available (v2.18+)
if API.features.hasGetEquippedItem and GetEquippedItem then
return GetEquippedItem(unitToken, slot)
end
-- Fallback: manual lookup for player
if unitToken ~= "player" then
return nil
end
local itemId = CleveRoids.ClassicAPI.GetInventoryItemID("player", slot) -- both are 1-indexed
if itemId then
return {
itemId = itemId,
}
end
return nil
end
-- Get all items in bags, or items in a specific bag
-- Requires v2.18+ for native GetBagItems (with Lua fallback)
-- bagIndex parameter requires v2.23+
-- If bagIndex is nil: returns nested table: bagIndex -> { slot -> itemInfo }
-- If bagIndex is specified: returns single table: slot -> itemInfo for that bag only
-- Bag indices: 0=backpack, 1-4=bags, -1=bank slots, 5-10=bank bags, -2=keyring
function API.GetBagItems(bagIndex)
-- Use native function if available (v2.18+)
if API.features.hasGetBagItems and GetBagItems then
-- bagIndex parameter requires v2.23+
if bagIndex ~= nil and not API.features.hasGetBagItemsWithIndex then
-- Fall through to Lua fallback for single-bag query on older versions
else
return GetBagItems(bagIndex)
end
end
-- Fallback: manual enumeration
if bagIndex ~= nil then
-- Single bag query
local bagContents = {}
local numSlots = GetContainerNumSlots(bagIndex) or 0
for slot = 1, numSlots do
local itemId = CleveRoids.ClassicAPI.GetContainerItemID(bagIndex, slot)
if itemId then
local _, count = GetContainerItemInfo(bagIndex, slot)
bagContents[slot] = {
itemId = itemId,
stackCount = count or 1,
}
end
end
return bagContents
end
-- All bags query
local bags = {}
for bag = 0, 4 do
local numSlots = GetContainerNumSlots(bag)
if numSlots > 0 then
bags[bag] = {}
for slot = 1, numSlots do
local itemId = CleveRoids.ClassicAPI.GetContainerItemID(bag, slot)
if itemId then
local _, count = GetContainerItemInfo(bag, slot)
bags[bag][slot] = {
itemId = itemId,
stackCount = count or 1,
}
end
end
end
end
return bags
end
-- Get item info for a specific bag slot
-- Requires v2.18+ for native GetBagItem (with Lua fallback)
function API.GetBagItem(bagIndex, slot)
-- Use native function if available (v2.18+)
if API.features.hasGetBagItem and GetBagItem then
return GetBagItem(bagIndex, slot)
end
-- Fallback: manual lookup
local itemId = CleveRoids.ClassicAPI.GetContainerItemID(bagIndex, slot)
if itemId then
local _, count = GetContainerItemInfo(bagIndex, slot)
return {
itemId = itemId,
stackCount = count or 1,
}
end
return nil
end
--------------------------------------------------------------------------------
-- OPTIMIZED ITEM FINDING (v2.18+)
-- These functions provide fast item lookup compatible with CleveRoids.Items format
--------------------------------------------------------------------------------
-- Fast item lookup using v2.18 FindPlayerItemSlot
-- Returns item info table compatible with CleveRoids.Items format:
-- { name, itemId, inventoryID } for equipped items
-- { name, itemId, bagID, slot } for bag items
-- Returns nil if item not found
function API.FindItemFast(itemIdOrName)
if not itemIdOrName then return nil end
-- Use native v2.18 function if available (much faster than Lua scan)
if FindPlayerItemSlot then
local bag, slot = FindPlayerItemSlot(itemIdOrName)
if slot then
local itemInfo = {}
if bag == nil then
-- Equipped item - Nampower returns 1-indexed slot directly
-- (matches WoW API's GetInventoryItemLink which is also 1-indexed)
local invSlot = slot
local link = GetInventoryItemLink("player", invSlot)
if link then
local _, _, itemId = string.find(link, "item:(%d+)")
local _, _, name = string.find(link, "|h%[(.-)%]|h")
itemInfo.inventoryID = invSlot
itemInfo.itemId = tonumber(itemId)
itemInfo.name = name
itemInfo._source = "nampower_equipped"
return itemInfo
end
else
-- Bag item
local link = GetContainerItemLink(bag, slot)
if link then
local _, _, itemId = string.find(link, "item:(%d+)")
local _, _, name = string.find(link, "|h%[(.-)%]|h")
local _, count = GetContainerItemInfo(bag, slot)
itemInfo.bagID = bag
itemInfo.slot = slot
itemInfo.itemId = tonumber(itemId)
itemInfo.name = name
itemInfo.count = count or 1
itemInfo._source = "nampower_bag"
return itemInfo
end
end
end
return nil -- Not found via native lookup
end
-- Fallback: no v2.18 API, return nil (caller should use existing methods)
return nil
end
-- Check if an item is equipped in a specific slot (fast)
-- Returns true if item matches by ID or name
function API.IsItemInSlot(itemIdOrName, inventorySlot)
if not itemIdOrName or not inventorySlot then return false end
-- Use native v2.18 GetEquippedItem if available
if GetEquippedItem then
local slotInfo = GetEquippedItem("player", inventorySlot) -- 1-indexed (1-19)
if slotInfo and slotInfo.itemId then
local checkId = tonumber(itemIdOrName)
if checkId then
return slotInfo.itemId == checkId
else
-- Check by name
local itemName = API.GetItemName(slotInfo.itemId)
if itemName then
return string.lower(itemName) == string.lower(itemIdOrName)
end
end
end
return false
end
-- Fallback: use GetInventoryItemLink
local link = GetInventoryItemLink("player", inventorySlot)
if not link then return false end
local checkId = tonumber(itemIdOrName)
if checkId then
local _, _, currentId = string.find(link, "item:(%d+)")
return currentId and tonumber(currentId) == checkId
else
local _, _, currentName = string.find(link, "|h%[(.-)%]|h")
return currentName and string.lower(currentName) == string.lower(itemIdOrName)
end
end
-- Check if item is equipped anywhere (fast)
-- Returns inventorySlot if equipped, nil otherwise
function API.FindEquippedItem(itemIdOrName)
if not itemIdOrName then return nil end
-- Use native v2.18 FindPlayerItemSlot if available
if FindPlayerItemSlot then
local bag, slot = FindPlayerItemSlot(itemIdOrName)
if bag == nil and slot then
return slot -- Nampower returns 1-indexed slot directly
end
return nil -- Not equipped (might be in bag or not found)
end
-- Fallback: scan equipped slots
local checkId = tonumber(itemIdOrName)
local checkName = (not checkId) and string.lower(itemIdOrName) or nil
for invSlot = 1, 19 do
local link = GetInventoryItemLink("player", invSlot)
if link then
if checkId then
local _, _, currentId = string.find(link, "item:(%d+)")
if currentId and tonumber(currentId) == checkId then
return invSlot
end
elseif checkName then
local _, _, currentName = string.find(link, "|h%[(.-)%]|h")
if currentName and string.lower(currentName) == checkName then
return invSlot
end
end
end
end
return nil
end
-- Find item in bags only (not equipped) - fast
-- Returns bag, slot if found, nil otherwise
function API.FindBagItem(itemIdOrName)
if not itemIdOrName then return nil, nil end
-- Use native v2.18 FindPlayerItemSlot if available
if FindPlayerItemSlot then
local bag, slot = FindPlayerItemSlot(itemIdOrName)
if bag ~= nil and slot then
return bag, slot
end
return nil, nil -- Not in bags (might be equipped or not found)
end
-- Fallback: scan bags
local checkId = tonumber(itemIdOrName)
local checkName = (not checkId) and string.lower(itemIdOrName) or nil
for bag = 0, 4 do
local numSlots = GetContainerNumSlots(bag) or 0
for slot = 1, numSlots do
if checkId then
if CleveRoids.ClassicAPI.GetContainerItemID(bag, slot) == checkId then
return bag, slot
end
elseif checkName then
local link = GetContainerItemLink(bag, slot)
if link then
local _, _, currentName = string.find(link, "|h%[(.-)%]|h")
if currentName and string.lower(currentName) == checkName then
return bag, slot
end
end
end
end
end
return nil, nil
end
-- Use an item by ID or name (fast lookup)
-- Returns true if item was used, false otherwise
function API.UseItem(itemIdOrName)
if not itemIdOrName then return false end
-- Try native v2.18 lookup first
local itemInfo = API.FindItemFast(itemIdOrName)
if itemInfo then
ClearCursor()
if itemInfo.inventoryID then
UseInventoryItem(itemInfo.inventoryID)
return true
elseif itemInfo.bagID and itemInfo.slot then
UseContainerItem(itemInfo.bagID, itemInfo.slot)
return true
end
end
-- No v2.18 API or item not found via native lookup
return false
end
-- Equip an item from bags to a specific slot (fast lookup)
-- Returns true if equip was attempted, false if item not found
function API.EquipItem(itemIdOrName, targetSlot)
if not itemIdOrName then return false end
-- Check if already equipped in target slot
if targetSlot and API.IsItemInSlot(itemIdOrName, targetSlot) then
return true -- Already equipped
end
-- Find the item
local itemInfo = API.FindItemFast(itemIdOrName)
if not itemInfo then return false end
-- If already equipped (but not in target slot), need to swap
if itemInfo.inventoryID then
if targetSlot and itemInfo.inventoryID ~= targetSlot then
-- Item equipped in wrong slot - pick up and move
ClearCursor()
PickupInventoryItem(itemInfo.inventoryID)
if CursorHasItem and CursorHasItem() then
EquipCursorItem(targetSlot)
ClearCursor()
return true
end
end
return true -- Already equipped (and no target slot specified)
end
-- Item in bag - equip it
if itemInfo.bagID and itemInfo.slot then
ClearCursor()
PickupContainerItem(itemInfo.bagID, itemInfo.slot)
if CursorHasItem and CursorHasItem() then
if targetSlot then
EquipCursorItem(targetSlot)
else
-- Auto-equip to appropriate slot
AutoEquipCursorItem()
end
ClearCursor()
return true
end
end
return false
end
--------------------------------------------------------------------------------
-- CAST INFO API (v2.18+)
--------------------------------------------------------------------------------
-- Get detailed information about current cast/channel
-- Requires v2.18+ for native GetCastInfo (with GetCurrentCastingInfo fallback for v2.0+)
-- Returns table with: castId, spellId, guid, castType, castStartS, castEndS,
-- castRemainingMs, castDurationMs, gcdEndS, gcdRemainingMs
-- Returns nil if no active cast
function API.GetCastInfo()
-- Use native function if available (v2.18+)
if API.features.hasGetCastInfo and GetCastInfo then
local ok, result = pcall(GetCastInfo)
if ok then
return result
end
-- If pcall failed, fall through to fallback
end
-- Fallback: use GetCurrentCastingInfo (less detailed, v2.0+)
if API.features.hasGetCurrentCastingInfo and GetCurrentCastingInfo then
local castId, visId, autoId, casting, channeling, onswing, autoattack = GetCurrentCastingInfo()
if castId and castId > 0 then
return {
spellId = castId,
castType = channeling == 1 and 3 or 0, -- 3 = CHANNEL, 0 = NORMAL
-- Timing info not available without native GetCastInfo
}
end
end
return nil
end
-- Check if currently casting (convenience wrapper)
function API.IsCasting()
local info = API.GetCastInfo()
return info ~= nil
end
-- Cached spell ID for GCD queries via GetSpellIdCooldown
local _gcdProbeSpellId = nil
-- Get GCD remaining in milliseconds
-- Uses GetSpellIdCooldown (works for instant casts) with GetCastInfo as fast-path
function API.GetGCDRemainingMs()
-- Fast path: GetCastInfo reports GCD during active casts/channels
local info = API.GetCastInfo()
if info and info.gcdRemainingMs and info.gcdRemainingMs > 0 then
return info.gcdRemainingMs
end
-- Primary path: GetSpellIdCooldown reads GCD from spell history (works after instant casts)
if API.features.hasGetSpellIdCooldown and _G.GetSpellIdCooldown then
-- Get a probe spell ID: first spell in the spellbook
if not _gcdProbeSpellId then
local name = GetSpellName(1, BOOKTYPE_SPELL)
if name and _G.GetSpellIdForName then
_gcdProbeSpellId = _G.GetSpellIdForName(name)
end
end
if _gcdProbeSpellId then
local cd = _G.GetSpellIdCooldown(_gcdProbeSpellId)
if cd and cd.gcdCategoryRemainingMs and cd.gcdCategoryRemainingMs > 0 then
return cd.gcdCategoryRemainingMs
end
end
end
return 0
end
-- Get cast remaining in milliseconds
function API.GetCastRemainingMs()
local info = API.GetCastInfo()
if info and info.castRemainingMs then
return info.castRemainingMs
end
return 0
end
--------------------------------------------------------------------------------
-- COOLDOWN API (v2.18+)
--------------------------------------------------------------------------------
-- Get detailed cooldown information for a spell
-- Requires v2.18+ for native GetSpellIdCooldown (with GetSpellCooldown fallback)
-- Returns table with: isOnCooldown, cooldownRemainingMs,
-- individual cooldown: individualStartS, individualDurationMs, individualRemainingMs, isOnIndividualCooldown
-- category cooldown: categoryId, categoryStartS, categoryDurationMs, categoryRemainingMs, isOnCategoryCooldown
-- GCD: gcdCategoryId, gcdCategoryStartS, gcdCategoryDurationMs, gcdCategoryRemainingMs, isOnGcdCategoryCooldown
-- item metadata (v2.23+): itemId, itemHasActiveSpell, itemActiveSpellId
function API.GetSpellCooldownInfo(spellId)
if not spellId or spellId == 0 then return nil end
-- Use native function if available (v2.18+)
if API.features.hasGetSpellIdCooldown and GetSpellIdCooldown then
return GetSpellIdCooldown(spellId)
end
-- Fallback: use GetSpellCooldown (less detailed)
local spellName = API.GetSpellNameById(spellId)
if spellName then
local start, duration = GetSpellCooldown(spellName, BOOKTYPE_SPELL)
if start and start > 0 then
local remaining = (start + duration) - GetTime()
if remaining > 0 then
return {
isOnCooldown = 1,
cooldownRemainingMs = remaining * 1000,
}
end
end
end
return { isOnCooldown = 0, cooldownRemainingMs = 0 }
end
-- Get detailed cooldown information for an item
-- Requires v2.18+ for native GetItemIdCooldown (with GetItemCooldown fallback)
-- Returns same table structure as GetSpellCooldownInfo
-- v2.23+ adds: itemId, itemHasActiveSpell, itemActiveSpellId
function API.GetItemCooldownInfo(itemId)
if not itemId or itemId == 0 then return nil end
-- Use native function if available (v2.18+)
if API.features.hasGetItemIdCooldown and GetItemIdCooldown then
return GetItemIdCooldown(itemId)
end
-- Fallback: use GetItemCooldown (less detailed)
local start, duration = GetItemCooldown(itemId)
if start and start > 0 then
local remaining = (start + duration) - GetTime()
if remaining > 0 then
return {
isOnCooldown = 1,
cooldownRemainingMs = remaining * 1000,
}
end
end
return { isOnCooldown = 0, cooldownRemainingMs = 0 }
end
-- Check if a spell is on cooldown (ignoring GCD)
function API.IsSpellOnCooldown(spellId, ignoreGCD)
local info = API.GetSpellCooldownInfo(spellId)
if not info then return false end
if ignoreGCD then
-- Only check individual and category cooldowns
return (info.isOnIndividualCooldown == 1) or (info.isOnCategoryCooldown == 1)
end
return info.isOnCooldown == 1
end
-- Get remaining cooldown for a spell in seconds
function API.GetSpellCooldownRemaining(spellId)
local info = API.GetSpellCooldownInfo(spellId)
if info and info.cooldownRemainingMs then
return info.cooldownRemainingMs / 1000
end
return 0
end
--------------------------------------------------------------------------------
-- CHANNEL CONTROL API (v2.18+)
--------------------------------------------------------------------------------
-- Stop channeling early on the next tick
-- Requires v2.18+ for ChannelStopCastingNextTick
-- Only works if NP_QueueChannelingSpells is enabled
function API.StopChannelNextTick()
if API.features.hasChannelStopCastingNextTick and ChannelStopCastingNextTick then
ChannelStopCastingNextTick()
return true
end
return false
end
--------------------------------------------------------------------------------
-- TRINKET API (v2.20+)
--------------------------------------------------------------------------------
-- Trinket slot constants
API.TRINKET_SLOT = {
FIRST = 13, -- First trinket slot (slot 13 in equipment)
SECOND = 14, -- Second trinket slot (slot 14 in equipment)
}
-- Get all trinkets (equipped and in bags)
-- Requires v2.20+ for native GetTrinkets (with Lua fallback)
-- Returns table with: itemId, trinketName, texture, itemLevel, bagIndex (nil=equipped), slotIndex
-- Pass copy=1 to get an independent copy safe for storage (v2.20+)
function API.GetTrinkets(copy)
-- Use native function if available (v2.20+)
if API.features.hasGetTrinkets and GetTrinkets then
-- Copy parameter supported in v2.20+
return GetTrinkets(copy)
end
-- Fallback: manual enumeration
local trinkets = {}
local index = 1
-- Check equipped trinket slots (13 and 14)
for _, slot in ipairs({13, 14}) do
local link = GetInventoryItemLink("player", slot)
if link then
local _, _, itemId = string.find(link, "item:(%d+)")
local _, _, name = string.find(link, "|h%[(.-)%]|h")
local texture = GetInventoryItemTexture("player", slot)
if itemId then
local numItemId = tonumber(itemId)
local itemLevel = API.GetItemLevel(numItemId)
trinkets[index] = {
itemId = numItemId,
trinketName = name or "Unknown",
texture = texture,
itemLevel = itemLevel,
bagIndex = nil, -- nil means equipped
slotIndex = slot == 13 and 1 or 2,
}
index = index + 1
end
end
end
-- Check bags for trinkets (inventoryType 12 = Trinket)
for bag = 0, 4 do
local numSlots = GetContainerNumSlots(bag) or 0
for slot = 1, numSlots do
local numItemId = CleveRoids.ClassicAPI.GetContainerItemID(bag, slot)
if numItemId then
local invType = API.GetItemInventoryType(numItemId)
if invType == 12 then -- Trinket
-- Only build the link string for actual trinkets, to read the name.
local link = GetContainerItemLink(bag, slot)
local name
if link then
local _
_, _, name = string.find(link, "|h%[(.-)%]|h")
end
local texture = GetContainerItemInfo(bag, slot)
local itemLevel = API.GetItemLevel(numItemId)
trinkets[index] = {
itemId = numItemId,
trinketName = name or "Unknown",
texture = texture,
itemLevel = itemLevel,
bagIndex = bag,
slotIndex = slot,
}
index = index + 1
end
end
end
end
return trinkets
end
-- Get cooldown for an equipped trinket
-- Requires v2.20+ for native GetTrinketCooldown (with Lua fallback)
-- slot: 1 or 13 = first trinket, 2 or 14 = second trinket
-- OR item ID (number) or item name (string) to match
-- Returns cooldown detail table (same as GetSpellIdCooldown/GetItemIdCooldown)
-- Returns -1 if no matching trinket is equipped
function API.GetTrinketCooldown(slot)
-- Use native function if available (v2.20+)
if API.features.hasGetTrinketCooldown and GetTrinketCooldown then
return GetTrinketCooldown(slot)
end
-- Normalize slot number
local equipSlot
if type(slot) == "number" then
if slot == 1 or slot == 13 then
equipSlot = 13
elseif slot == 2 or slot == 14 then
equipSlot = 14
else
-- Treat as item ID - find in trinket slots
for _, checkSlot in ipairs({13, 14}) do
local link = GetInventoryItemLink("player", checkSlot)
if link then
local _, _, currentId = string.find(link, "item:(%d+)")
if currentId and tonumber(currentId) == slot then
equipSlot = checkSlot
break
end
end
end
end
elseif type(slot) == "string" then
-- Match by name
local slotLower = string.lower(slot)
for _, checkSlot in ipairs({13, 14}) do
local link = GetInventoryItemLink("player", checkSlot)
if link then
local _, _, name = string.find(link, "|h%[(.-)%]|h")
if name and string.lower(name) == slotLower then
equipSlot = checkSlot
break
end
end
end
end
if not equipSlot then
return -1 -- No matching trinket found
end
-- Get item ID from equipped slot
local itemId = CleveRoids.ClassicAPI.GetInventoryItemID("player", equipSlot)
if not itemId then
return -1
end
-- Get cooldown info
return API.GetItemCooldownInfo(itemId)
end
-- Use an equipped trinket
-- Requires v2.20+ for native UseTrinket (with Lua fallback)
-- slot: 1 or 13 = first trinket, 2 or 14 = second trinket
-- OR item ID (number) or item name (string) to match
-- target: optional unit token or GUID
-- Returns: 1 if used, 0 if use failed, -1 if trinket not found
function API.UseTrinket(slot, target)
-- Use native function if available (v2.20+)
if API.features.hasUseTrinket and UseTrinket then
return UseTrinket(slot, target)
end
-- Normalize slot number
local equipSlot
if type(slot) == "number" then
if slot == 1 or slot == 13 then
equipSlot = 13
elseif slot == 2 or slot == 14 then
equipSlot = 14
else
-- Treat as item ID - find in trinket slots
for _, checkSlot in ipairs({13, 14}) do
local link = GetInventoryItemLink("player", checkSlot)
if link then
local _, _, currentId = string.find(link, "item:(%d+)")
if currentId and tonumber(currentId) == slot then
equipSlot = checkSlot
break
end
end
end
end
elseif type(slot) == "string" then
-- Match by name
local slotLower = string.lower(slot)
for _, checkSlot in ipairs({13, 14}) do
local link = GetInventoryItemLink("player", checkSlot)
if link then
local _, _, name = string.find(link, "|h%[(.-)%]|h")
if name and string.lower(name) == slotLower then
equipSlot = checkSlot
break
end
end
end
end
if not equipSlot then
return -1 -- No matching trinket found
end
-- Use the trinket
ClearCursor()
UseInventoryItem(equipSlot)
return 1
end
--------------------------------------------------------------------------------
-- ITEM USAGE API (v2.20+)
--------------------------------------------------------------------------------
-- Use an item by ID or name
-- Requires v2.20+ for native UseItemIdOrName (with Lua fallback)
-- itemIdOrName: item ID (number) or item name (string)
-- target: optional unit token or GUID
-- Returns: 1 if used successfully, 0 if not found or use failed
function API.UseItemIdOrName(itemIdOrName, target)
-- Use native function if available (v2.20+)
if API.features.hasUseItemIdOrName and UseItemIdOrName then
return UseItemIdOrName(itemIdOrName, target)
end
-- Fallback: use existing API.UseItem
if API.UseItem(itemIdOrName) then
return 1
end
return 0
end
--------------------------------------------------------------------------------
-- DISENCHANT API (v2.22+)
--------------------------------------------------------------------------------
-- Automatically disenchant items in inventory
-- Requires v2.22+ for DisenchantAll (no fallback available)
-- Mode 1: DisenchantAll(itemIdOrName, [includeSoulbound]) - specific item by ID/name
-- Mode 2: DisenchantAll(quality, [includeSoulbound]) - "greens", "blues", or "greens|blues" (v2.23+)
-- includeSoulbound: pass 1 to include soulbound items (default: 0)
-- Returns: 1 if first disenchant succeeded, 0 if no items found or failed
--
-- WARNING: This function WILL disenchant items without confirmation!
-- Quest items are always protected. Soulbound items protected by default.
-- Only affects bags 0-4 (not bank).
function API.DisenchantAll(itemIdOrNameOrQuality, includeSoulbound)
-- Use native function if available (v2.22+)
if API.features.hasDisenchantAll and DisenchantAll then
return DisenchantAll(itemIdOrNameOrQuality, includeSoulbound)
end
-- No fallback available - requires Nampower 2.22+
return 0
end
--------------------------------------------------------------------------------
-- EVENT CONSTANTS (v2.18+, updated v2.20)
--------------------------------------------------------------------------------
-- Spell queue event codes
API.QUEUE_EVENT = {
ON_SWING_QUEUED = 0,
ON_SWING_QUEUE_POPPED = 1,
NORMAL_QUEUED = 2,
NORMAL_QUEUE_POPPED = 3,
NON_GCD_QUEUED = 4,
NON_GCD_QUEUE_POPPED = 5,
}
-- Spell cast event types
API.CAST_TYPE = {
NORMAL = 1,
NON_GCD = 2,
ON_SWING = 3,
CHANNEL = 4,
TARGETING = 5,
TARGETING_NON_GCD = 6,
}
-- Buff/debuff event names (v2.18+)
-- Parameters: guid, slot, spellId, stackCount, auraLevel (v2.20+), auraSlot (v2.30+, raw 0-based),
-- state (v2.32+, 0=added/1=removed/2=modified)
API.AURA_EVENTS = {
"BUFF_ADDED_SELF",
"BUFF_REMOVED_SELF",
"BUFF_ADDED_OTHER",
"BUFF_REMOVED_OTHER",
"DEBUFF_ADDED_SELF",
"DEBUFF_REMOVED_SELF",
"DEBUFF_ADDED_OTHER",
"DEBUFF_REMOVED_OTHER",
}
-- Aura cast event names (v2.20+, requires NP_EnableAuraCastEvents=1)
-- Parameters: spellId, casterGuid, targetGuid, effect, effectAuraName,
-- effectAmplitude, effectMiscValue, durationMs, auraCapStatus
-- auraCapStatus bitfield: 1 = buff bar full, 2 = debuff bar full
API.AURA_CAST_EVENTS = {
"AURA_CAST_ON_SELF", -- Fires when aura lands on active player
"AURA_CAST_ON_OTHER", -- Fires when aura lands on other units
}
-- Aura cap status bitfield values (for AURA_CAST events)
API.AURA_CAP_STATUS = {
BUFF_BAR_FULL = 1,
DEBUFF_BAR_FULL = 2,
BOTH_FULL = 3,
}
-- Aura event state constants (v2.32+)
-- The 7th parameter on BUFF/DEBUFF_ADDED/REMOVED events
API.AURA_STATE = {
ADDED = 0, -- Newly added aura
REMOVED = 1, -- Fully removed aura
MODIFIED = 2, -- Stack change (ADDED if increased, REMOVED if decreased)
}
-- Aura duration update event names (v2.30+)
-- Fires when a buff/debuff duration is refreshed on the player
-- Parameters: auraSlot (0-based raw slot index), durationMs, expirationTimeMs, spellId (v2.33+)
API.AURA_DURATION_EVENTS = {
"BUFF_UPDATE_DURATION_SELF", -- Player buff duration refreshed
"DEBUFF_UPDATE_DURATION_SELF", -- Player debuff duration refreshed
}
-- Auto-attack event names (v2.24+, requires NP_EnableAutoAttackEvents=1)
-- Parameters: attackerGuid, targetGuid, totalDamage, hitInfo, victimState,
-- subDamageCount, blockedAmount, totalAbsorb, totalResist
API.AUTO_ATTACK_EVENTS = {
"AUTO_ATTACK_SELF", -- Fires when active player is the target
"AUTO_ATTACK_OTHER", -- Fires when active player is attacker or different unit is target
}
-- HitInfo bitfield values (for AUTO_ATTACK events)
-- Converted to decimal for Lua 5.0 compatibility (no hex literals)
API.HITINFO = {
NORMALSWING = 0,
UNK0 = 1,
AFFECTS_VICTIM = 2,
LEFTSWING = 4, -- Off-hand attack
UNK3 = 8,
MISS = 16, -- 0x10
ABSORB = 32, -- 0x20
RESIST = 64, -- 0x40
CRITICALHIT = 128, -- 0x80
UNK8 = 256, -- 0x100
UNK9 = 8192, -- 0x2000
GLANCING = 16384, -- 0x4000
CRUSHING = 32768, -- 0x8000
NOACTION = 65536, -- 0x10000
SWINGNOHITSOUND = 524288, -- 0x80000
}
-- VictimState values (for AUTO_ATTACK events)
API.VICTIMSTATE = {
UNAFFECTED = 0, -- Seen with HITINFO_MISS
NORMAL = 1,
DODGE = 2,
PARRY = 3,
INTERRUPT = 4,
BLOCKS = 5,
EVADES = 6,
IS_IMMUNE = 7,
DEFLECTS = 8,
}
-- Unit GUID events (v2.39+)
-- Fire once per unit state change, identified by GUID rather than unit token.
-- Unlike standard UNIT_HEALTH etc. (one event per registered token), each GUID event
-- fires exactly once and carries flags for player/target/mouseover/pet/party/raid.
-- Parameters: guid, isPlayer, isTarget, isMouseover, isPet, partyIndex, raidIndex
API.UNIT_GUID_EVENTS = {
"UNIT_HEALTH_GUID",
"UNIT_MANA_GUID",
"UNIT_RAGE_GUID",
"UNIT_ENERGY_GUID",
"UNIT_PET_GUID",
"UNIT_FLAGS_GUID",
"UNIT_AURA_GUID",
"UNIT_DYNAMIC_FLAGS_GUID",
"UNIT_NAME_UPDATE_GUID",
"UNIT_PORTRAIT_UPDATE_GUID",
"UNIT_MODEL_CHANGED_GUID",
"UNIT_INVENTORY_CHANGED_GUID",
"PLAYER_GUILD_UPDATE_GUID",
-- UNIT_COMBAT_GUID: guid, action, damage, school, hitInfo, isPet, partyIndex, raidIndex
"UNIT_COMBAT_GUID",
}
-- Spell start/go event names (v2.25+)
-- These provide improved granularity over UNIT_CASTEVENT for spell cast tracking
-- SPELL_START: Server notifies a spell with cast time has begun
-- SPELL_GO: Server notifies a spell has completed casting (projectile launched, instant landed)
-- v2.38+: SPELL_START includes arg7=durationMs, arg8=spellType
-- v2.40+: SPELL_START includes arg9=corpseOwnerGuid (string or nil)
-- v2.40+: SPELL_GO includes arg8=corpseOwnerGuid (string or nil)
API.SPELL_START_EVENTS = {
"SPELL_START_SELF", -- Player starts casting (requires NP_EnableSpellStartEvents=1)
"SPELL_START_OTHER", -- Other unit starts casting
}
API.SPELL_GO_EVENTS = {
"SPELL_GO_SELF", -- Player's spell completed/fired (requires NP_EnableSpellGoEvents=1)
"SPELL_GO_OTHER", -- Other unit's spell completed/fired
}
-- Spell heal event names (v2.26+, requires NP_EnableSpellHealEvents=1)
-- Parameters: targetGuid, casterGuid, spellId, amount, isCritical, isPeriodic
API.SPELL_HEAL_EVENTS = {
"SPELL_HEAL_BY_SELF", -- Player healed a target
"SPELL_HEAL_BY_OTHER", -- Other unit healed a target
"SPELL_HEAL_ON_SELF", -- Player was healed
}
-- Spell energize event names (v2.26+, requires NP_EnableSpellEnergizeEvents=1)
-- Parameters: targetGuid, casterGuid, spellId, powerType, amount, isPeriodic
-- powerType: 0=mana, 1=rage, 2=focus, 3=energy, 4=happiness
API.SPELL_ENERGIZE_EVENTS = {
"SPELL_ENERGIZE_BY_SELF", -- Player energized a target
"SPELL_ENERGIZE_BY_OTHER", -- Other unit energized a target
"SPELL_ENERGIZE_ON_SELF", -- Player was energized
}
-- Power type constants (for SPELL_ENERGIZE events)
API.POWER_TYPE = {
MANA = 0,
RAGE = 1,
FOCUS = 2,
ENERGY = 3,
HAPPINESS = 4,
}
-- Unit events (v2.20+)
API.UNIT_EVENTS = {
"UNIT_DIED", -- Parameters: guid
}
-- Spell school constants (for reference)
API.SPELL_SCHOOL = {
PHYSICAL = 0,
HOLY = 1,
FIRE = 2,
NATURE = 3,
FROST = 4,
SHADOW = 5,
ARCANE = 6,
}
-- Resistance indices (1-indexed for Lua tables)
API.RESISTANCE_INDEX = {
ARMOR = 1,
HOLY = 2,
FIRE = 3,
NATURE = 4,
FROST = 5,
SHADOW = 6,
ARCANE = 7,
}
--------------------------------------------------------------------------------
-- SPELL MODIFIERS API (GetSpellModifiers)
--------------------------------------------------------------------------------
-- Modifier type constants
API.MODIFIER_DAMAGE = 0
API.MODIFIER_DURATION = 1
API.MODIFIER_THREAT = 2
API.MODIFIER_ATTACK_POWER = 3
API.MODIFIER_CHARGES = 4
API.MODIFIER_RANGE = 5
API.MODIFIER_RADIUS = 6
API.MODIFIER_CRITICAL_CHANCE = 7
API.MODIFIER_ALL_EFFECTS = 8
API.MODIFIER_NOT_LOSE_CASTING_TIME = 9
API.MODIFIER_CASTING_TIME = 10
API.MODIFIER_COOLDOWN = 11
API.MODIFIER_SPEED = 12
API.MODIFIER_COST = 14
API.MODIFIER_CRIT_DAMAGE_BONUS = 15
API.MODIFIER_RESIST_MISS_CHANCE = 16
API.MODIFIER_JUMP_TARGETS = 17
API.MODIFIER_CHANCE_OF_SUCCESS = 18
API.MODIFIER_ACTIVATION_TIME = 19
API.MODIFIER_EFFECT_PAST_FIRST = 20
API.MODIFIER_CASTING_TIME_OLD = 21
API.MODIFIER_DOT = 22
API.MODIFIER_HASTE = 23
API.MODIFIER_SPELL_BONUS_DAMAGE = 24
API.MODIFIER_MULTIPLE_VALUE = 27
API.MODIFIER_RESIST_DISPEL_CHANCE = 28
-- Get spell modifiers
-- Requires v2.8+ for GetSpellModifiers
-- Returns: flatMod, percentMod, hasModifier
function API.GetModifiers(spellId, modifierType)
if not API.features.hasGetSpellModifiers or not GetSpellModifiers then
return 0, 0, false
end
if not spellId or spellId == 0 then
return 0, 0, false
end
local flat, percent, ret = GetSpellModifiers(spellId, modifierType)
return flat or 0, percent or 0, ret and ret ~= 0
end
-- Get duration modifier for a spell (useful for debuff tracking)
-- Returns modified duration given base duration
function API.GetModifiedDuration(spellId, baseDuration)
if not baseDuration then return nil end
local flat, percent, hasModifier = API.GetModifiers(spellId, API.MODIFIER_DURATION)
if not hasModifier then
return baseDuration
end
-- Apply flat modifier first, then percentage
-- Nampower returns percent as final multiplier (90 = 90% of original, not -10% change)
local modified = baseDuration + flat
if percent ~= 0 then
modified = modified * (percent / 100)
end
return modified
end
-- Get damage modifier for a spell
function API.GetDamageModifier(spellId)
local flat, percent = API.GetModifiers(spellId, API.MODIFIER_DAMAGE)
return flat, percent
end
-- Get cooldown modifier for a spell
function API.GetCooldownModifier(spellId)
local flat, percent = API.GetModifiers(spellId, API.MODIFIER_COOLDOWN)
return flat, percent
end
-- Get cast time modifier for a spell
function API.GetCastTimeModifier(spellId)
local flat, percent = API.GetModifiers(spellId, API.MODIFIER_CASTING_TIME)
return flat, percent
end
-- Get cost modifier for a spell
function API.GetCostModifier(spellId)
local flat, percent = API.GetModifiers(spellId, API.MODIFIER_COST)
return flat, percent
end
--------------------------------------------------------------------------------
-- ENHANCED SPELL LOOKUP (using new "spellId:number" and name syntax)
--------------------------------------------------------------------------------
-- Convert spell identifier to spellId:number format if needed
-- Input can be: spellSlot (number), "spellId:123", or "Spell Name"
function API.NormalizeSpellIdentifier(identifier, bookType)
if not identifier then return nil end
-- Already in spellId:number format
if type(identifier) == "string" and string.find(identifier, "^spellId:") then
return identifier
end
-- If it's a number and enhanced functions exist, keep as-is (slot) or convert to spellId
if type(identifier) == "number" then
if API.features.hasEnhancedSpellFunctions then
-- Could be a spell slot - check if we have GetSpellSlotTypeIdForName to get the ID
if identifier > 0 and identifier < 1000 then
-- Likely a spell slot, use as-is
return identifier, bookType or BOOKTYPE_SPELL
else
-- Likely a spell ID, convert to spellId:number format
return "spellId:" .. identifier
end
end
return identifier, bookType
end
-- It's a spell name
if type(identifier) == "string" then
-- If enhanced functions available, pass name directly
if API.features.hasEnhancedSpellFunctions then
return identifier
end
-- Fall back to manual lookup
local spell = CleveRoids.GetSpell and CleveRoids.GetSpell(identifier)
if spell then
return spell.spellSlot, spell.bookType
end
end
return nil
end
-- Get spell texture (works with name, spellId:number, or slot)
function API.GetSpellTexture(identifier, bookType)
if API.features.hasEnhancedSpellFunctions then
-- Pass directly to native function
local id = API.NormalizeSpellIdentifier(identifier)
if id then
return GetSpellTexture(id, bookType)
end
else
-- Fall back to slot-based lookup
local slot, book = API.NormalizeSpellIdentifier(identifier, bookType)
if slot then
return GetSpellTexture(slot, book or BOOKTYPE_SPELL)
end
end
return nil
end
-- Get item icon texture by display info ID (v2.27+)
-- Parameters:
-- displayInfoId (number): The item's display info ID from GetItemStatsField(itemId, "displayInfoID")
-- Returns:
-- Texture path string (e.g., "Interface\Icons\INV_Sword_04"), or nil if not found
function API.GetItemIconTexture(displayInfoId)
if not displayInfoId or type(displayInfoId) ~= "number" then
return nil
end
if API.features.hasGetItemIconTexture and GetItemIconTexture then
return GetItemIconTexture(displayInfoId)
end
return nil
end
-- Get item icon texture by item ID (convenience wrapper)
-- Parameters:
-- itemId (number): The item's ID
-- Returns:
-- Texture path string, or nil if not found
function API.GetItemIconTextureByItemId(itemId)
if not itemId or type(itemId) ~= "number" then
return nil
end
-- Get displayInfoID from item stats
if GetItemStatsField then
local displayInfoId = GetItemStatsField(itemId, "displayInfoID")
if displayInfoId then
return API.GetItemIconTexture(displayInfoId)
end
end
return nil
end
-- Get spell icon texture by spell icon ID (v2.27+)
-- Parameters:
-- spellIconId (number): The spell's icon ID from GetSpellRecField(spellId, "spellIconID")
-- Returns:
-- Texture path string with Interface\Icons\ prefix (e.g., "Interface\Icons\Spell_Frost_FrostBolt02"), or nil if not found
function API.GetSpellIconTexture(spellIconId)
if not spellIconId or type(spellIconId) ~= "number" then
return nil
end
if API.features.hasGetSpellIconTexture and GetSpellIconTexture then
return GetSpellIconTexture(spellIconId)
end
return nil
end
-- Get spell icon texture by spell ID (convenience wrapper)
-- Parameters:
-- spellId (number): The spell's ID
-- Returns:
-- Texture path string, or nil if not found
function API.GetSpellIconTextureBySpellId(spellId)
if not spellId or type(spellId) ~= "number" then
return nil
end
-- Get spellIconID from spell record
if GetSpellRecField then
local spellIconId = GetSpellRecField(spellId, "spellIconID")
if spellIconId then
return API.GetSpellIconTexture(spellIconId)
end
end
return nil
end
-- Get spell name (works with name, spellId:number, or slot)
function API.GetSpellName(identifier, bookType)
if API.features.hasEnhancedSpellFunctions then
local id = API.NormalizeSpellIdentifier(identifier)
if id then
return GetSpellName(id, bookType)
end
else
local slot, book = API.NormalizeSpellIdentifier(identifier, bookType)
if slot then
return GetSpellName(slot, book or BOOKTYPE_SPELL)
end
end
return nil
end
-- Get spell cooldown (works with name, spellId:number, or slot)
-- Returns: start, duration (same as native)
function API.GetSpellCooldown(identifier, bookType)
if API.features.hasEnhancedSpellFunctions then
local id = API.NormalizeSpellIdentifier(identifier)
if id then
return GetSpellCooldown(id, bookType)
end
else
local slot, book = API.NormalizeSpellIdentifier(identifier, bookType)
if slot then
return GetSpellCooldown(slot, book or BOOKTYPE_SPELL)
end
end
return nil
end
-- Check if spell is passive
function API.IsSpellPassive(identifier, bookType)
if API.features.hasEnhancedSpellFunctions then
local id = API.NormalizeSpellIdentifier(identifier)
if id then
return IsSpellPassive(id, bookType)
end
else
local slot, book = API.NormalizeSpellIdentifier(identifier, bookType)
if slot then
return IsSpellPassive(slot, book or BOOKTYPE_SPELL)
end
end
return nil
end
--------------------------------------------------------------------------------
-- SPELL ID LOOKUP UTILITIES
--------------------------------------------------------------------------------
-- Cache for spell ID lookups
API.spellIdCache = {}
-- Get spell ID from name (cached)
function API.GetSpellIdFromName(spellName)
if not spellName then return nil end
-- Check cache
if API.spellIdCache[spellName] then
return API.spellIdCache[spellName]
end
-- Use Nampower's GetSpellIdForName
if GetSpellIdForName then
local spellId = GetSpellIdForName(spellName)
if spellId and spellId > 0 then
API.spellIdCache[spellName] = spellId
return spellId
end
end
return nil
end
-- Get spell slot, book type, and ID from name
function API.GetSpellSlotInfo(spellName)
if not spellName then return nil end
-- Use Nampower's GetSpellSlotTypeIdForName
if GetSpellSlotTypeIdForName then
local slot, bookType, spellId = GetSpellSlotTypeIdForName(spellName)
if slot and slot > 0 then
return slot, bookType, spellId
end
end
-- Fallback to CleveRoids.GetSpell
if CleveRoids.GetSpell then
local spell = CleveRoids.GetSpell(spellName)
if spell then
local spellId = API.GetSpellIdFromName(spellName)
return spell.spellSlot, spell.bookType, spellId
end
end
return nil
end
--------------------------------------------------------------------------------
-- INITIALIZATION
--------------------------------------------------------------------------------
-- Hook UnitBuff/UnitDebuff to append spell IDs when SuperWoW is not available
-- SuperWoW extends these to return spell IDs as extra return values.
-- Without SuperWoW, we use GetUnitField(unit, "aura") to look up spell IDs.
-- GetUnitField "aura" returns [1-32]=buff spellIDs, [33-48]=debuff spellIDs
local function InstallAuraSpellIdHooks()
if CleveRoids.hasSuperwow then return end -- SuperWoW already provides spell IDs
if not _G.GetUnitField then return end -- Need GetUnitField for aura data
local _origUnitBuff = _G.UnitBuff
local _origUnitDebuff = _G.UnitDebuff
-- UnitBuff(unit, index) => texture, stacks, spellID
-- SuperWoW returns: texture, stacks, spellID
_G.UnitBuff = function(unit, index)
local texture, stacks = _origUnitBuff(unit, index)
if not texture then return nil end
local spellID = nil
local auras = _G.GetUnitField(unit, "aura")
if auras then
-- Buff index i maps to aura slot i (1-based)
spellID = auras[index]
if spellID and spellID <= 0 then spellID = nil end
end
return texture, stacks, spellID
end
-- UnitDebuff(unit, index) => texture, stacks, debuffType, spellID
-- SuperWoW returns: texture, stacks, debuffType, spellID
_G.UnitDebuff = function(unit, index)
local texture, stacks, debuffType = _origUnitDebuff(unit, index)
if not texture then return nil end
local spellID = nil
local auras = _G.GetUnitField(unit, "aura")
if auras then
-- Debuff index i maps to aura slot 32 + i (1-based)
spellID = auras[32 + index]
if spellID and spellID <= 0 then spellID = nil end
end
return texture, stacks, debuffType, spellID
end
end
-- Initialize the API module
function API.Initialize()
-- Detect enhanced spell functions
DetectEnhancedSpellFunctions()
-- Install UnitBuff/UnitDebuff spell ID hooks (when SuperWoW not available)
InstallAuraSpellIdHooks()
-- Auto-enable required Nampower event CVars.
-- Nampower reads CVars at DLL load time, so changes take effect on next reload.
-- We set them now so every subsequent session works automatically.
if SetCVar and GetCVar then
local f = API.features
-- NP_EnableAuraCastEvents (v2.20+) - required for [debuffcapped], [mybuffcapped], overflow buff tracking
if f.hasAuraCastEvents and GetCVar("NP_EnableAuraCastEvents") ~= "1" then
SetCVar("NP_EnableAuraCastEvents", "1")
end
-- NP_EnableAutoAttackEvents (v2.24+) - required for [lastswing], [incominghit]
if f.hasAutoAttackEvents and GetCVar("NP_EnableAutoAttackEvents") ~= "1" then
SetCVar("NP_EnableAutoAttackEvents", "1")
end
-- NP_EnableSpellStartEvents (v2.25+) - required for SPELL_START_SELF/OTHER cast tracking
if f.hasSpellStartEvents and GetCVar("NP_EnableSpellStartEvents") ~= "1" then
SetCVar("NP_EnableSpellStartEvents", "1")
end
-- NP_EnableSpellGoEvents (v2.25+) - required for SPELL_GO_SELF/OTHER cast tracking
if f.hasSpellGoEvents and GetCVar("NP_EnableSpellGoEvents") ~= "1" then
SetCVar("NP_EnableSpellGoEvents", "1")
end
end
end
-- Clear caches (call on respec/spell change)
function API.ClearCaches()
API.spellRecCache = {}
API.itemStatsCache = {}
API.spellIdCache = {}
API.settingsCache = {}
API.spellTypeCache = {}
end
--------------------------------------------------------------------------------
-- CONVENIENCE WRAPPERS FOR EXISTING CODE
--------------------------------------------------------------------------------
-- Check if a spell is in range (wrapper around IsSpellInRange with fallbacks)
function API.IsSpellInRange(spellIdentifier, unit)
unit = unit or "target"
-- Convert name to ID if needed
local spellId = nil
local checkValue = spellIdentifier
if type(spellIdentifier) == "string" and not string.find(spellIdentifier, "^spellId:") then
spellId = API.GetSpellIdFromName(spellIdentifier)
if spellId and spellId > 0 then
checkValue = spellId
end
elseif type(spellIdentifier) == "number" then
spellId = spellIdentifier
end
-- Check for self-cast spells FIRST before native range check
-- Self-targeted spells are always in range regardless of what IsSpellInRange returns
if spellId and spellId > 0 then
local rangeIndex = API.GetSpellField(spellId, "rangeIndex")
-- rangeIndex 0 = Self Only, 14 = Self Only (alternate), 23 = Touch
if rangeIndex == 0 or rangeIndex == 14 or rangeIndex == 23 then
return 1 -- Self-targeted spells are always in range
end
-- Fallback: if rangeIndex lookup failed but spell range is 0, it's self-only
if rangeIndex == nil then
local spellRange = API.GetSpellRange(spellId)
if spellRange == 0 or spellRange == nil then
return 1 -- Assume self-only if range is 0 or unknown
end
end
end
-- Try native IsSpellInRange (wrapped in pcall to handle invalid spell IDs)
local nativeResult = nil
if IsSpellInRange then
local success, result = pcall(IsSpellInRange, checkValue, unit)
if success then
nativeResult = result
-- result == 1 (in range), 0 (out of range), -1 (invalid/non-unit-targeted), nil (error)
if nativeResult == 0 or nativeResult == 1 then
return nativeResult
end
end
-- If pcall failed, nativeResult stays nil and we fall through to UnitXP
end
-- If native returned -1, check DBC target type to determine handling
if nativeResult == -1 and spellId and spellId > 0 then
local isUnitTargeted = API.IsUnitTargetedSpell(spellId)
if isUnitTargeted then
-- Unit-targeted spell (like channeled Arcane Missiles) - use distance check
local spellRange = API.GetSpellRange(spellId)
if spellRange and spellRange > 0 and CleveRoids.hasUnitXP and UnitExists(unit) then
local distance = UnitXP("distanceBetween", "player", unit)
if distance then
return (distance <= spellRange) and 1 or 0
end
end
-- Fall through to return 1 if we can't check distance
end
-- Non-unit-targeted spell (self-cast like Presence of Mind, or ground-targeted like Blizzard)
-- Always in range
return 1
end
-- For nil results (native couldn't determine), try UnitXP distance check
if spellId and spellId > 0 and CleveRoids.hasUnitXP and UnitExists(unit) then
local spellRange = API.GetSpellRange(spellId)
if spellRange and spellRange > 0 then
local distance = UnitXP("distanceBetween", "player", unit)
if distance then
return (distance <= spellRange) and 1 or 0
end
end
end
return nil -- Can't determine
end
-- Check if a spell is usable (wrapper around IsSpellUsable)
-- Returns usable, oom on success; nil on error (spell not in spellbook)
function API.IsSpellUsable(spellIdentifier)
if not _G.IsSpellUsable then
return nil
end
-- If enhanced functions available, pass directly
if API.features.hasEnhancedSpellFunctions then
local ok, usable, oom = pcall(_G.IsSpellUsable, spellIdentifier)
if ok then return usable, oom end
return nil
end
-- Convert to ID if name
if type(spellIdentifier) == "string" then
local spellId = API.GetSpellIdFromName(spellIdentifier)
if spellId then
local ok, usable, oom = pcall(_G.IsSpellUsable, spellId)
if ok then return usable, oom end
return nil
end
end
local ok, usable, oom = pcall(_G.IsSpellUsable, spellIdentifier)
if ok then return usable, oom end
return nil
end
--------------------------------------------------------------------------------
-- SMART CASTING SYSTEM
--------------------------------------------------------------------------------
-- Spell type constants
API.SPELL_TYPE_UNKNOWN = 0
API.SPELL_TYPE_CAST = 1 -- Has cast time
API.SPELL_TYPE_INSTANT = 2 -- Instant, on GCD
API.SPELL_TYPE_CHANNEL = 3 -- Channeled spell
API.SPELL_TYPE_ON_SWING = 4 -- Next-melee (Heroic Strike, etc.)
API.SPELL_TYPE_NON_GCD = 5 -- Instant, not on GCD (trinkets, etc.)
-- Known on-swing spells (by name, localized via CleveRoids.Localized when available)
API.onSwingSpells = {
["Heroic Strike"] = true,
["Cleave"] = true,
["Maul"] = true,
["Slam"] = true,
["Raptor Strike"] = true,
["Mongoose Bite"] = true,
}
-- Known channeled spells (by name)
API.channeledSpells = {
["Arcane Missiles"] = true,
["Blizzard"] = true,
["Drain Life"] = true,
["Drain Mana"] = true,
["Drain Soul"] = true,
["Evocation"] = true,
["Health Funnel"] = true,
["Hellfire"] = true,
["Hurricane"] = true,
["Mind Flay"] = true,
["Rain of Fire"] = true,
["Tranquility"] = true,
["Volley"] = true,
["Mind Soothe"] = true,
["Mind Vision"] = true,
["First Aid"] = true, -- Bandaging
}
-- Cache for spell type lookups
API.spellTypeCache = {}
-- Determine spell type for a given spell
-- Returns: SPELL_TYPE_* constant
function API.GetSpellType(spellName)
if not spellName then return API.SPELL_TYPE_UNKNOWN end
-- Strip rank from name for cache lookup
local baseName = string.gsub(spellName, "%s*%([Rr]ank%s*%d+%)%s*$", "")
-- Check cache first
if API.spellTypeCache[baseName] then
return API.spellTypeCache[baseName]
end
local spellType = API.SPELL_TYPE_UNKNOWN
-- Check known on-swing spells first (highest priority)
if API.onSwingSpells[baseName] then
spellType = API.SPELL_TYPE_ON_SWING
API.spellTypeCache[baseName] = spellType
return spellType
end
-- Check known channeled spells
if API.channeledSpells[baseName] then
spellType = API.SPELL_TYPE_CHANNEL
API.spellTypeCache[baseName] = spellType
return spellType
end
-- Try to use GetSpellRec for accurate detection
local spellId = API.GetSpellIdFromName(spellName)
if spellId and spellId > 0 and API.features.hasGetSpellRec then
local rec = API.GetSpellRecord(spellId)
if rec then
-- Check for channeled via attributes
-- SPELL_ATTR_EX_CHANNELED = 4 (0x00000004) in attributesEx
local attrEx = rec.attributesEx or 0
if bit and bit.band(attrEx, 4) ~= 0 then
spellType = API.SPELL_TYPE_CHANNEL
API.spellTypeCache[baseName] = spellType
return spellType
end
-- Check cast time
local castTime = rec.castTime or 0
if castTime > 0 then
spellType = API.SPELL_TYPE_CAST
else
-- Instant spell - check if it's on GCD
-- startRecoveryTime > 0 means it triggers GCD
local recoveryTime = rec.startRecoveryTime or 0
if recoveryTime > 0 then
spellType = API.SPELL_TYPE_INSTANT
else
spellType = API.SPELL_TYPE_NON_GCD
end
end
API.spellTypeCache[baseName] = spellType
return spellType
end
end
-- Fallback: assume instant if no other info
-- This is safe because Nampower will handle it correctly anyway
spellType = API.SPELL_TYPE_INSTANT
API.spellTypeCache[baseName] = spellType
return spellType
end
-- Get the queue setting name for a spell type
local function GetQueueSettingForType(spellType)
if spellType == API.SPELL_TYPE_CAST then
return "NP_QueueCastTimeSpells"
elseif spellType == API.SPELL_TYPE_INSTANT then
return "NP_QueueInstantSpells"
elseif spellType == API.SPELL_TYPE_CHANNEL then
return "NP_QueueChannelingSpells"
elseif spellType == API.SPELL_TYPE_ON_SWING then
return "NP_QueueOnSwingSpells"
elseif spellType == API.SPELL_TYPE_NON_GCD then
return "NP_QueueInstantSpells" -- Non-GCD uses instant setting
end
return nil
end
-- Check if queuing is enabled for a specific spell
function API.IsSpellQueueingEnabled(spellName)
if not API.features.hasSpellQueue then
return false
end
local spellType = API.GetSpellType(spellName)
local settingName = GetQueueSettingForType(spellType)
if settingName then
return API.GetSettingBool(settingName)
end
-- Default: use cast time spell setting
return API.GetSettingBool("NP_QueueCastTimeSpells")
end
-- Smart cast function that uses QueueSpellByName when appropriate
-- Returns: true if cast was attempted, false otherwise
-- Parameters:
-- spellName: The spell name (with optional rank)
-- target: Optional target unit (for SuperWoW CastSpellByName)
-- forceQueue: If true, always use QueueSpellByName (if available, v2.0+)
-- forceNoQueue: If true, never use QueueSpellByName
function API.SmartCast(spellName, target, forceQueue, forceNoQueue)
if not spellName then return false end
-- Determine whether to use queuing
local useQueue = false
if forceNoQueue then
useQueue = false
elseif forceQueue then
useQueue = API.features.hasSpellQueue
else
-- Check if queuing is enabled for this spell type
useQueue = API.IsSpellQueueingEnabled(spellName)
end
-- Check if we have a non-standard target (e.g., @mouseover)
-- QueueSpellByName in older Nampower versions doesn't support target parameter
-- Only Nampower v2.13+ supports QueueSpellByName with target
local hasNonStandardTarget = target and target ~= "target"
local canQueueWithTarget = API.features.hasQueueSpellWithTarget
-- Cast the spell
if useQueue and API.features.hasSpellQueue and QueueSpellByName then
if hasNonStandardTarget then
if canQueueWithTarget then
-- Nampower v2.13+ supports target parameter in QueueSpellByName
QueueSpellByName(spellName, target)
return true
else
-- Older Nampower: can't queue with non-standard target
-- Fall through to CastSpellByName with target
end
else
-- No target or target is "target" - safe to use queue
QueueSpellByName(spellName)
return true
end
end
-- Use standard casting (either queuing wasn't possible or we need target support)
if CastSpellByName then
if target and CleveRoids.hasSuperwow then
-- SuperWoW supports target parameter
CastSpellByName(spellName, target)
else
CastSpellByName(spellName)
end
return true
end
return false
end
-- Cast without queuing (uses CastSpellByNameNoQueue if available, v2.12+; v3.1+ supports unit target)
function API.CastNoQueue(spellName, target)
if not spellName then return false end
-- Use Nampower's no-queue function if available (v2.12+)
if API.features.hasCastSpellByNameNoQueue and CastSpellByNameNoQueue then
if target then
CastSpellByNameNoQueue(spellName, target)
else
CastSpellByNameNoQueue(spellName)
end
return true
end
-- Fall back to standard cast
if CastSpellByName then
if target then
CastSpellByName(spellName, target)
else
CastSpellByName(spellName)
end
return true
end
return false
end
-- Cast by spell ID without queuing (v3.1+)
function API.CastNoQueueById(spellId, target)
if not spellId then return false end
if API.features.hasCastSpellNoQueue and _G.CastSpellNoQueue then
if target then
_G.CastSpellNoQueue(spellId, 0, target)
else
_G.CastSpellNoQueue(spellId, 0)
end
return true
end
-- Fall back to CastNoQueue by name
local name = API.GetSpellNameById(spellId)
if name then
return API.CastNoQueue(name, target)
end
return false
end
-- Force queue a spell (uses QueueSpellByName directly, v2.0+)
function API.ForceQueue(spellName)
if not spellName then return false end
if API.features.hasSpellQueue and QueueSpellByName then
QueueSpellByName(spellName)
return true
end
-- Fall back to standard cast if queue not available
if CastSpellByName then
CastSpellByName(spellName)
return true
end
return false
end
-- Queue a script to run after current cast (uses QueueScript if available, v2.12+)
function API.QueueScript(script, priority)
if not script then return false end
if API.features.hasQueueScript and QueueScript then
QueueScript(script, priority or 1)
return true
end
return false
end
-- Get equipped ammo ID and total count (v2.29+)
-- Returns: ammoId, ammoCount (or nil, nil if unavailable)
function API.GetAmmo()
if not API.features.hasGetAmmo or not _G.GetAmmo then
return nil, nil
end
return _G.GetAmmo()
end
-- Get player aura duration info by raw slot index (v2.30+)
-- auraSlot: 0-based raw aura slot (0-31 = buffs, 32-47 = debuffs)
-- Returns: spellId, durationMs, expirationTimeMs (or nil if unavailable)
function API.GetPlayerAuraDuration(auraSlot)
if not API.features.hasGetPlayerAuraDuration or not _G.GetPlayerAuraDuration then
return nil, nil, nil
end
return _G.GetPlayerAuraDuration(auraSlot)
end
-- Count occupied player buff slots using GetPlayerAuraDuration (v2.30+)
-- Returns: count of occupied buff slots (0-32), or nil if unavailable
function API.CountPlayerBuffSlots()
if not API.features.hasGetPlayerAuraDuration or not _G.GetPlayerAuraDuration then
return nil
end
local count = 0
for i = 0, 31 do
local spellId = _G.GetPlayerAuraDuration(i)
if spellId and spellId > 0 then
count = count + 1
end
end
return count
end
-- Count occupied player debuff slots using GetPlayerAuraDuration (v2.30+)
-- Returns: count of occupied debuff slots (0-16), or nil if unavailable
function API.CountPlayerDebuffSlots()
if not API.features.hasGetPlayerAuraDuration or not _G.GetPlayerAuraDuration then
return nil
end
local count = 0
for i = 32, 47 do
local spellId = _G.GetPlayerAuraDuration(i)
if spellId and spellId > 0 then
count = count + 1
end
end
return count
end
-- Clear spell type cache (call on spec change)
function API.ClearSpellTypeCache()
API.spellTypeCache = {}
end
--------------------------------------------------------------------------------
-- SPELL MISS CONSTANTS (v2.31+)
--------------------------------------------------------------------------------
-- MissInfo enum values from SPELL_MISS_SELF/OTHER events
API.MISS_INFO = {
NONE = 0, MISS = 1, RESIST = 2, DODGE = 3, PARRY = 4, BLOCK = 5,
EVADE = 6, IMMUNE = 7, IMMUNE2 = 8, DEFLECT = 9, ABSORB = 10, REFLECT = 11,
}
--------------------------------------------------------------------------------
-- SPELL POWER QUERY (v2.31+)
--------------------------------------------------------------------------------
-- Get duration of a spell in milliseconds (v2.38+)
-- For channeling spells: returns the channel duration.
-- For non-channeling spells: returns the first aura effect duration.
-- spellId: spell ID to look up
-- ignoreModifiers: pass 1 to ignore talent/buff modifiers (returns base duration)
-- Returns: duration in ms (0 if spell has no duration), or nil if spellId invalid
function API.GetSpellDuration(spellId, ignoreModifiers)
if not API.features.hasGetSpellDuration or not _G.GetSpellDuration then
return nil
end
return _G.GetSpellDuration(spellId, ignoreModifiers)
end
--------------------------------------------------------------------------------
-- AURA CANCEL FUNCTIONS (v2.34+)
--------------------------------------------------------------------------------
-- Cancel a player aura by raw 0-based aura slot (v2.34+)
-- auraSlot: 0-31 for buffs, 32-47 for debuffs
function API.CancelPlayerAuraSlot(auraSlot)
if not API.features.hasCancelPlayerAuraSlot or not _G.CancelPlayerAuraSlot then
return false
end
_G.CancelPlayerAuraSlot(auraSlot)
return true
end
-- Cancel a player aura by spell ID (v2.34+)
-- spellId: the spell ID to cancel
-- ignoreMissing: pass 1 to skip aura-slot presence check (useful for buff-capped hidden auras)
function API.CancelPlayerAuraSpellId(spellId, ignoreMissing)
if not API.features.hasCancelPlayerAuraSpellId or not _G.CancelPlayerAuraSpellId then
return false
end
_G.CancelPlayerAuraSpellId(spellId, ignoreMissing)
return true
end
--------------------------------------------------------------------------------
-- TALENT HELPER (v2.35+)
--------------------------------------------------------------------------------
-- Learn a specific talent rank directly (v2.35+)
-- talentPage: 1-3 (talent tab)
-- talentIndex: 1-32 (talent position within tab)
-- rank: 1-5 (rank to learn)
function API.LearnTalentRank(talentPage, talentIndex, rank)
if not API.features.hasLearnTalentRank or not _G.LearnTalentRank then
return false
end
if not talentPage or not talentIndex or not rank then return false end
if talentPage < 1 or talentPage > 3 then return false end
if talentIndex < 1 or talentIndex > 32 then return false end
if rank < 1 or rank > 5 then return false end
_G.LearnTalentRank(talentPage, talentIndex, rank)
return true
end
-- Get unit GUID by token (v3.0+)
-- Supports extended tokens: mark1-mark8, owner/target/pet suffixes
function API.GetUnitGUID(unitToken)
if not API.features.hasGetUnitGUID or not _G.GetUnitGUID then
return nil
end
return _G.GetUnitGUID(unitToken)
end
-- Check if a spell's aura would be hidden from Lua aura APIs (v3.0+)
function API.IsAuraHidden(spellId)
if not API.features.hasIsAuraHidden or not _G.IsAuraHidden then
return nil
end
return _G.IsAuraHidden(spellId)
end
-- Get spell range data from SpellRange DBC by rangeIndex (v4.0+)
-- Returns minRange, maxRange, flags, name or nil if unavailable/invalid
-- flags: 0 = ranged, 1 = melee (Combat Range)
-- Note: returned ranges are raw DBC values before combat reach adjustments
function API.GetSpellRangeData(rangeIndex)
if not API.features.hasGetSpellRangeData or not _G.GetSpellRangeData then
return nil
end
return _G.GetSpellRangeData(rangeIndex)
end
--------------------------------------------------------------------------------
-- HEALTH/POWER WRAPPERS (GetUnitField extended token support with fallback)
--------------------------------------------------------------------------------
-- Get unit health via GetUnitField (extended token support) with standard API fallback
function API.GetUnitHealth(unitToken)
if API.features.hasGetUnitField and GetUnitField then
local val = GetUnitField(unitToken, "health")
if val then return val end
end
return UnitHealth(unitToken)
end
function API.GetUnitMaxHealth(unitToken)
if API.features.hasGetUnitField and GetUnitField then
local val = GetUnitField(unitToken, "maxHealth")
if val then return val end
end
return UnitHealthMax(unitToken)
end
-- Expose API globally for other addons
_G.CleveRoidsNampowerAPI = API