Files
WeakestAuras/GenericTrigger.lua
T
github-actions[bot] 5d26104f61 WeakestAuras 0.9.0
WeakestAuras 0.9.0

WeakAuras2 compatibility

- Import many WeakAuras2 export strings, including Wago.io strings, with translation reports and review before installation.
- Added compatibility for WeakAuras2 groups, sub-regions, anchors, conditions, load rules, generic triggers and bundled media.
- Native import/export supports duplicate detection, import-as-copy and individual-aura updates.

Runtime and authoring

- Added custom event triggers and Trigger State Updater custom clones.
- Added clone support for group, party, raid and nameplate unit producers, with dynamic-group sorting, limits and per-unit anchoring.
- Added display animations, chat/sound/custom/glow actions, custom options and additional Classic-era triggers.
- Improved aura tracking beyond the client?s harmful-aura slot limit and strengthened cooldown/GCD handling.
- Bundled additional licensed fonts, status bars, sounds and textures.

Documentation

- Expanded the public README with feature coverage, known limitations, official documentation guidance, Wago.io warnings and sharing instructions.
2026-08-16 11:45:05 +00:00

5030 lines
228 KiB
Lua

-- WeakestAuras -- GenericTrigger-lite: the runtime trigger system for every
-- non-aura trigger kind. Ported from WeakAuras2's GenericTrigger (ref
-- WA2's GenericTrigger (§4), scaled to this client.
--
-- The payoff of the whole engine: a new trigger *category* is a data table (an
-- "event prototype" in PROTOTYPES) declaring its game/internal events, an `init`
-- preamble, an `args` list, and optional display hooks -- no new system code.
-- One prototype's args drive its test function, its state fields, its condition
-- variables (§10) and its options editor at once.
--
-- Split faithful to upstream (and to Conditions.lua's own reasoning): the
-- *matching* logic (init + per-arg tests + stores) is compiled to one Lua
-- function per trigger via ConstructFunction/loadstring -- prototype fragments
-- are Lua source by design, so an interpreter would loadstring the pieces
-- anyway. The *display* side (duration/name/icon) stays plain Lua closures the
-- system calls after a successful test, exactly as upstream's durationFunc/
-- nameFunc/iconFunc do. loadstring is confirmed on this client (StateMachine's
-- customTriggerLogic, Conditions' deferred custom). /wa gen <id> dumps the
-- generated source, making source-assembly errors readable.
if WeakestAuras.disabled then return end
local WA = WeakestAuras
local GenericTrigger = {}
-- events[id][triggernum] = triggerInfo (this display's compiled generic
-- triggers). Present after Add (compile); a ti only enters loaded_events (starts
-- receiving events) once the display is loaded (§11).
local events = {}
-- loaded_events[event][id][triggernum] = triggerInfo -- the dispatch index a
-- game/internal event walks (§4.3). Both game and internal events live here;
-- only game events are RegisterEvent'd on the frame (internal ones arrive via
-- WA.ScanEvents from a watcher).
local loaded_events = {}
-- activeIds[id] = true while this display's tis are in loaded_events (it's
-- loaded). Keeps Load/Unload idempotent.
local activeIds = {}
-- The tis a Delete just retired, kept only until the next Add compares its
-- sourceKey against them (see GenericTrigger.Delete).
local lastCompiled = {}
-- The display being compiled, and the ids whose compile could not resolve a
-- spell or item name. A name resolves to an id baked into the generated source,
-- so an unresolved one leaves that trigger dead until something recompiles it --
-- which is the entire reason the addon recompiles on spell/item cache traffic
-- (OptionsFrame.lua's debounced sweep). Nothing else about a compile depends on
-- the caches, so once every name has an id that sweep has nothing left to fix.
local compilingId
local unresolvedIds = {}
local function noteUnresolved()
if compilingId then unresolvedIds[compilingId] = true end
end
-- Whether any compiled display is still waiting on a name the client cannot
-- resolve yet.
function WA.HasUnresolvedNames()
for _ in pairs(unresolvedIds) do return true end
return false
end
-- Internal (WA-generated) event names never handed to Frame:RegisterEvent -- a
-- watcher re-dispatches them through WA.ScanEvents instead (§4.4).
local INTERNAL_EVENTS = {
SPELL_COOLDOWN_CHANGED = true,
SPELL_COOLDOWN_READY = true,
ITEM_COOLDOWN_CHANGED = true,
ITEM_COOLDOWN_READY = true,
EQUIPSLOT_COOLDOWN_CHANGED = true,
EQUIPSLOT_COOLDOWN_READY = true,
GCD_UPDATE = true,
GCD_END = true,
-- Re-emitted by the threat watcher after parsing a TWThreat addon-message
-- broadcast (there's no threat game event; see the watcher below).
WA_THREAT_CHANGED = true,
-- Re-emitted by the totem watcher after a SPELL_GO_SELF totem drop commits.
WA_TOTEM_UPDATE = true,
-- Re-emitted by the swing-timer watcher on a swing reset / rescale / stop.
WA_SWING_UPDATE = true,
-- Re-emitted with the cast spell id after the player's own cast completes.
WA_SPELL_CAST_SUCCEEDED = true,
-- A shared 1s heartbeat for status prototypes whose value depletes with no
-- natural game event (weapon-enchant / crowd-control remaining time). Started
-- lazily by WA.EnsureSlowTick when such a trigger loads (below).
WA_SLOW_TICK = true,
-- A shared 0.1s heartbeat for status prototypes that track a fast-moving
-- value (range to a unit). Started lazily by WA.EnsureFastTick.
WA_FAST_TICK = true,
-- Fired after the player's login/loading-screen state has settled. Native
-- status APIs such as GetMoney can return their usable value only after the
-- initial PLAYER_ENTERING_WORLD burst.
WA_DELAYED_PLAYER_ENTERING_WORLD = true,
-- Re-emitted by the power-tick watcher when a regen tick is inferred or the
-- timer stops (power type change, full power).
WA_POWERTICK_UPDATE = true,
-- Upstream's per-frame custom-trigger pulse, carrying the frame's elapsed
-- time. Driven by an OnUpdate rather than C_Timer, which cannot schedule
-- per-frame; per-trigger onUpdateThrottle is what keeps it affordable.
FRAME_UPDATE = true,
}
-- ---------------------------------------------------------------------------
-- Code-generation helpers (ConstructFunction, §4.2)
-- ---------------------------------------------------------------------------
-- A config value as a Lua literal for embedding in generated source. %q handles
-- string quoting/escaping (Lua 5.0 has it); numbers/bools go verbatim.
local function fmt(v)
if type(v) == "number" then return tostring(v)
elseif type(v) == "boolean" then return v and "true" or "false"
elseif v == nil then return "nil"
else return string.format("%q", tostring(v)) end
end
-- Splits a user-typed "EVT_A, EVT_B EVT_C" event string (custom-trigger config)
-- into a trimmed list. Commas and any whitespace both separate; empty tokens are
-- dropped. Pattern string ops are fine on Lua 5.0 (gsub/find with patterns work;
-- only gmatch is missing).
local function parseEventList(str)
local out = {}
if not str or str == "" then return out end
local s = string.gsub(str, ",", " ")
local pos = 1
while true do
local a, b = string.find(s, "%s+", pos)
local tok
if a then tok = string.sub(s, pos, a - 1); pos = b + 1
else tok = string.sub(s, pos) end
if tok ~= "" then table.insert(out, tok) end
if not a then break end
end
return out
end
local COMMON_CUSTOM_EVENTS = {
"PLAYER_ENTERING_WORLD", "PLAYER_TARGET_CHANGED", "PLAYER_REGEN_DISABLED",
"PLAYER_REGEN_ENABLED", "UNIT_AURA", "UNIT_HEALTH", "UNIT_MANA",
"UNIT_ENERGY", "UNIT_RAGE", "BAG_UPDATE", "SPELLS_CHANGED",
"SPELL_UPDATE_COOLDOWN", "ACTIONBAR_UPDATE_COOLDOWN", "READY_CHECK",
"PARTY_MEMBERS_CHANGED", "RAID_ROSTER_UPDATE", "CHAT_MSG_SAY",
"CHAT_MSG_PARTY", "CHAT_MSG_RAID", "CHAT_MSG_WHISPER", "UNIT_CASTEVENT",
}
local customEventSearch = {}
-- One "EVENT:a:b" token's colon-separated parts.
local function splitEventToken(token)
local parts = {}
for part in string.gfind(token, "[^:]+") do table.insert(parts, part) end
return parts
end
-- A custom trigger's event list in upstream's extended syntax, resolved into the
-- three things this client can act on: the events to register, a per-event set of
-- unit tokens to filter arg1 against, and the trigger numbers to watch.
--
-- "UNIT_AURA:player:target" is a filter rather than a narrower registration --
-- RegisterUnitEvent does not exist on this client (gotchas.md), so the general
-- event is registered and dispatch drops payloads whose unit is not listed.
-- "TRIGGER:2" names another of the display's triggers and registers no game
-- event at all. A "CLEU:"/"COMBAT_LOG_EVENT_UNFILTERED:" token resolves to
-- nothing: this client's combat log is SuperWoW's RAW_COMBATLOG, whose adapter
-- does not exist, and registering the modern name would silently never fire.
local function parseCustomEventList(str)
local eventList, unitFilters, watched = {}, nil, nil
local tokens = parseEventList(str)
for i = 1, table.getn(tokens) do
local token = tokens[i]
local parts = splitEventToken(token)
local base = parts[1]
local upper = base and string.upper(base) or ""
if upper == "CLEU" or upper == "COMBAT_LOG_EVENT_UNFILTERED" then
-- no adapter
elseif upper == "TRIGGER" then
for p = 2, table.getn(parts) do
local num = tonumber(parts[p])
if num then
watched = watched or {}
watched[num] = true
end
end
elseif table.getn(parts) > 1 and string.find(upper, "^UNIT_") then
table.insert(eventList, base)
unitFilters = unitFilters or {}
local set = unitFilters[base] or {}
unitFilters[base] = set
for p = 2, table.getn(parts) do
set[string.lower(parts[p])] = true
end
else
table.insert(eventList, base or token)
end
end
return eventList, unitFilters, watched
end
local function isClientEvent(name)
if INTERNAL_EVENTS[name] then return true end
if not (C_EventUtils and C_EventUtils.IsEventValid) then return true end
return C_EventUtils.IsEventValid(name) and true or false
end
-- Names the editor should warn about. A token carrying the extended syntax is
-- judged on its base event, and the two forms that name no game event at all are
-- exempt rather than reported as unregisterable.
local function invalidEventList(str)
local invalid = {}
local names = parseEventList(str)
for i = 1, table.getn(names) do
local parts = splitEventToken(names[i])
local base = parts[1] or names[i]
local upper = string.upper(base)
if upper == "TRIGGER" or upper == "CLEU" or upper == "COMBAT_LOG_EVENT_UNFILTERED" then
-- resolves to no game event
elseif not isClientEvent(base) then
table.insert(invalid, names[i])
end
end
return invalid
end
local function eventPickerValues(query)
local values, labels = {}, {}
local needle = string.upper(query or "")
local source = needle == "" and COMMON_CUSTOM_EVENTS or (WA.customEventCatalog or {})
for i = 1, table.getn(source) do
local name = source[i]
if isClientEvent(name)
and (needle == "" or string.find(name, needle, 1, true)) then
table.insert(values, name)
labels[name] = name
if table.getn(values) >= 40 then break end
end
end
if table.getn(values) == 0 then
table.insert(values, "__NO_EVENT_MATCH__")
labels.__NO_EVENT_MATCH__ = "No matching events"
end
return values, labels
end
local function appendEventName(str, name)
if name == "__NO_EVENT_MATCH__" then return str or "" end
local names = parseEventList(str)
for i = 1, table.getn(names) do
if names[i] == name then return str or "" end
end
if not str or not string.find(str, "%S") then return name end
return str .. " " .. name
end
local VALID_OPS = { ["=="] = true, ["~="] = true, ["<"] = true,
["<="] = true, [">"] = true, [">="] = true }
local function safeOp(op)
return VALID_OPS[op] and op or "=="
end
-- The comparisons a `string` arg offers, and their editor captions.
local STRING_OPS = { "==", "~=", "find", "notfind" }
local STRING_OP_LABELS = { ["=="] = "Is", ["~="] = "Is Not",
find = "Contains", notfind = "Doesn't Contain" }
-- The test source for one arg, or nil if it contributes none. A `test` win:
-- either a format string with a single %s for the user value, or a function
-- (trigger) -> source-string for config-branching tests (e.g. genericShowOn's
-- three show modes each need a different comparison, not one template). A test
-- function returning nil contributes no test. Otherwise a number arg becomes a
-- gated `name <op> value` comparison.
local function constructArgTest(arg, trigger)
if arg.test then
if type(arg.test) == "function" then
local src = arg.test(trigger)
if not src then return nil end
return "(" .. src .. ")"
end
return "(" .. string.format(arg.test, fmt(trigger[arg.name])) .. ")"
end
if arg.type == "number" then
if not arg.required and not trigger["use_" .. arg.name] then return nil end
local op = safeOp(trigger[arg.name .. "_operator"] or ">=")
local test = string.format("(%s %s %s)", arg.name, op, fmt(trigger[arg.name] or 0))
-- A second bound on the same value turns one comparison into a range
-- ("between 20 and 50"), which one operator cannot express. Parenthesised
-- as a unit so it stays one term however the caller joins the tests.
if arg.multiEntry and trigger["use_" .. arg.name .. "2"] then
local op2 = safeOp(trigger[arg.name .. "2_operator"] or "<=")
return string.format("(%s and (%s %s %s))", test, arg.name, op2,
fmt(trigger[arg.name .. "2"] or 0))
end
return test
elseif arg.type == "select" then
if not arg.required and not trigger["use_" .. arg.name] then return nil end
return string.format("(%s == %s)", arg.name, fmt(trigger[arg.name]))
elseif arg.type == "string" then
if not arg.required and not trigger["use_" .. arg.name] then return nil end
local op = trigger[arg.name .. "_operator"] or "=="
local val = fmt(trigger[arg.name] or "")
-- find/notfind are plain substring searches (find's 4th argument), not Lua
-- patterns: spell and unit names carry magic characters the user should not
-- have to escape. Both sides lowered so matching is case-insensitive, and
-- the nil guard matters because a stored name is nil until its unit exists.
if op == "find" then
return string.format("(%s ~= nil and string.find(string.lower(%s), string.lower(%s), 1, true) ~= nil)",
arg.name, arg.name, val)
elseif op == "notfind" then
return string.format("(%s == nil or string.find(string.lower(%s), string.lower(%s), 1, true) == nil)",
arg.name, arg.name, val)
elseif op == "~=" then
return string.format("(%s ~= %s)", arg.name, val)
end
return string.format("(%s == %s)", arg.name, val)
end
return nil
end
-- Compiles prototype+trigger into one test function (§4.2). Signature
-- (state, event, arg1..arg9): the status prototypes re-read live game state in
-- `init` and ignore the event args, but the parameters carry the firing event's
-- real payload, so a prototype can test against it instead of re-polling.
local function constructFunction(proto, trigger, errTag)
local lines = {}
table.insert(lines, "return function(state, event, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9)")
if proto.init then
table.insert(lines, proto.init(trigger))
end
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
if arg.init then
table.insert(lines, string.format("local %s = %s", arg.name, arg.init))
end
end
local tests = {}
for i = 1, table.getn(proto.args) do
local t = constructArgTest(proto.args[i], trigger)
if t then table.insert(tests, t) end
end
local cond = table.getn(tests) > 0 and table.concat(tests, " and ") or "true"
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
if arg.store and arg.storeAlways then
table.insert(lines, string.format(
"if state.%s ~= %s then state.%s = %s state.changed = true end",
arg.name, arg.name, arg.name, arg.name))
end
end
table.insert(lines, "if (" .. cond .. ") then")
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
if arg.store and not arg.storeAlways then
table.insert(lines, string.format(
"if state.%s ~= %s then state.%s = %s state.changed = true end",
arg.name, arg.name, arg.name, arg.name))
end
end
table.insert(lines, "return true else return false end")
table.insert(lines, "end")
local source = table.concat(lines, "\n")
-- Engine-generated, so it keeps the real globals: the sandbox belongs to the
-- code's author, not to the call site. The source is already complete, `return
-- function(...)` and all, which is why it goes through the builtin door.
local fn, err = WA.LoadBuiltinFunction(source, errTag)
return fn, source, err
end
-- Compiles a custom trigger's user text into a function.
-- The text is a whole function expression ("function(event, ...) ... end");
-- WA.LoadFunction owns the wrapper, the sandbox and the error report. Shape
-- mirrors constructFunction's return contract (fn, source, err).
local function constructCustomFunction(trigger, errTag)
local body = trigger.custom or ""
local fn, err = WA.LoadFunction(body, errTag)
return fn, body, err
end
local function compileCustomField(source, errTag)
if not source or not string.find(source, "%S") then return nil end
return WA.LoadFunction(source, errTag)
end
-- A Trigger State Updater's `customVariables` text is a table *expression*, not a
-- function, so it is wrapped into one that returns it. The newlines around the
-- body keep a trailing comment from swallowing the closing `end`.
local function compileTsuVariables(source, errTag)
if not source or not string.find(source, "%S") then return nil end
return WA.LoadFunction("function() return \n" .. source .. "\n end", errTag)
end
local function trueFunction() return true end
-- Resolves a "spell" field's stored value -- a numeric spellID, or a name the
-- user typed -- to a numeric spellID, or nil if it doesn't resolve to
-- anything (yet). Numeric input is trusted as-is and never round-tripped
-- through a lookup: the legacy GetSpellInfo(spellID) works for *any* spell
-- ID, known or not (ref ClassicAPI docs §Spell), so a raw ID the player
-- hasn't learned still resolves. A name only resolves through C_Spell's name
-- resolver (FUN_RESOLVE_SPELL_NAME_TO_BOOK_ID, the same chain
-- CastSpellByName uses) -- unlike the numeric path, that's bounded to the
-- player's own known spellbook, so a name for a spell they don't have (wrong
-- spelling, wrong class, not yet learned) legitimately has no numeric ID to
-- resolve to and this returns nil.
function WA.ResolveSpellID(input)
if input == nil or input == "" then return nil end
local id = tonumber(input)
if id then return id end
if C_Spell and C_Spell.GetSpellInfo then
local info = C_Spell.GetSpellInfo(input)
if info and info.spellID then return info.spellID end
end
noteUnresolved()
return nil
end
-- Resolves an "item" field's stored value (a numeric itemID, or a name/
-- link the user typed) to a numeric itemID, or nil if it doesn't resolve to
-- anything (yet -- an uncached name needs the client to have seen the item
-- once, same GetItemInfo caveat as any other addon). No plain-Lua item-name-
-- >ID API exists, so a name resolves through GetItemInfo's link return and a
-- string.find capture (this client's Lua 5.0 has no string.match, ref
-- TextReplace.lua).
-- ---------------------------------------------------------------------------
-- The spellbook, indexed by name. The global cooldown is read off a slot because
-- there is no GCD spellID to query, and Debug.lua's /wa cdprobe reads slots to
-- show what each rank of a name reports. Ranks of a name occupy consecutive
-- ascending slots, so the last write wins and the index holds the highest rank
-- (the same rank walk DoiteAuras does before its own GetSpellCooldown calls).
-- ---------------------------------------------------------------------------
local spellSlotByName, spellSlotById
local function buildSpellSlotIndex()
spellSlotByName, spellSlotById = {}, {}
if not (GetNumSpellTabs and GetSpellTabInfo and GetSpellName) then return end
for tab = 1, (GetNumSpellTabs() or 0) do
local _, _, offset, numSlots = GetSpellTabInfo(tab)
if offset and numSlots then
for i = offset + 1, offset + numSlots do
local name = GetSpellName(i, BOOKTYPE_SPELL or "spell")
if name then spellSlotByName[name] = i end
end
end
end
end
function WA.InvalidateSpellSlots()
spellSlotByName, spellSlotById = nil, nil
end
-- Slot numbers shift as the book grows, so every cached one stops meaning
-- anything. Registered here rather than on a consumer's frame: the per-spell
-- cooldown watcher depends on this index whether or not anything is watching the
-- global cooldown.
local spellBookFrame = CreateFrame("Frame")
pcall(spellBookFrame.RegisterEvent, spellBookFrame, "SPELLS_CHANGED")
pcall(spellBookFrame.RegisterEvent, spellBookFrame, "LEARNED_SPELL_IN_TAB")
spellBookFrame:SetScript("OnEvent", WA.InvalidateSpellSlots)
function WA.SpellSlotByName(name)
if not name then return nil end
if not spellSlotByName then buildSpellSlotIndex() end
return spellSlotByName[name]
end
-- Slot for a spellID, via its name -- so a specific rank's ID still lands on the
-- book's highest rank, which is what actually goes on cooldown.
function WA.SpellSlotByID(spellId)
if not spellId or spellId == 0 then return nil end
if not spellSlotById then
if not spellSlotByName then buildSpellSlotIndex() end
spellSlotById = {}
end
local hit = spellSlotById[spellId]
if hit ~= nil then return hit or nil end
local name = C_Spell and C_Spell.GetSpellName and C_Spell.GetSpellName(spellId)
local slot = name and spellSlotByName[name]
spellSlotById[spellId] = slot or false
return slot
end
-- (start, duration) off a spellbook slot, or nil. pcall'd: a slot that has gone
-- out of range (the book shrank) raises rather than answering.
function WA.SpellSlotCooldown(slot)
if not slot or not GetSpellCooldown then return nil end
local ok, start, duration = pcall(GetSpellCooldown, slot, BOOKTYPE_SPELL or "spell")
if not ok or not start or not duration then return nil end
return start, duration
end
-- itemID for a name the user typed, found by walking the player's own
-- containers. Nothing on this client resolves a name: C_Item.GetItemCount and
-- C_Item.GetItemInfo both take an id, an "item:N" string or a link, and say so
-- explicitly -- so an item named rather than linked can only be identified by
-- finding one you hold. A hit is memoized for good (an id never stops belonging
-- to a name); a miss is only rate-limited, since the item may simply not be
-- carried yet and looting one must start working without a reload.
local itemIdByName = {}
local itemNameMissAt = {}
local ITEM_NAME_RESCAN = 0.5
-- Bags the scan walks. GetContainerItemID documents 0 (backpack) and 1..4
-- (equipped bags); the bank indices are tried anyway because the count call
-- reads the bank cold here, and an unsupported index just answers nil.
local SCAN_BAGS = { 0, 1, 2, 3, 4, -1, 5, 6, 7, 8, 9, 10 }
function WA.ItemIDByName(name)
if not name or name == "" then return nil end
local lname = string.lower(name)
if itemIdByName[lname] then return itemIdByName[lname] end
local last = itemNameMissAt[lname]
if last and (GetTime() - last) < ITEM_NAME_RESCAN then return nil end
local function matches(id)
if not id then return nil end
local n = C_Item and C_Item.GetItemNameByID and C_Item.GetItemNameByID(id)
if n and string.lower(n) == lname then return id end
return nil
end
local function remember(id)
itemIdByName[lname] = id
itemNameMissAt[lname] = nil
return id
end
-- Equipped first: cheapest, and the one place a bag walk cannot look.
if GetInventoryItemID then
for slot = 1, 19 do
local hit = matches(GetInventoryItemID("player", slot))
if hit then return remember(hit) end
end
end
if C_Container and C_Container.GetContainerItemID and GetContainerNumSlots then
for i = 1, table.getn(SCAN_BAGS) do
local bag = SCAN_BAGS[i]
for slot = 1, (GetContainerNumSlots(bag) or 0) do
local hit = matches(C_Container.GetContainerItemID(bag, slot))
if hit then return remember(hit) end
end
end
end
itemNameMissAt[lname] = GetTime()
return nil
end
-- A name that missed can only start resolving once the player is carrying one,
-- and the id a miss baked into a trigger's compiled source is not revisited on
-- its own. GET_ITEM_INFO_RECEIVED (OptionsFrame.lua's recompile hook) covers an
-- item whose *static data* had not arrived; it does not fire for an item already
-- in the client's cache that simply was not in a bag yet, which is what this
-- covers. Shaped after upstream's itemDataLoadFrame: the retry only walks while
-- a name is outstanding, and a name that starts resolving recompiles.
local itemNameRetryFrame = CreateFrame("Frame")
pcall(itemNameRetryFrame.RegisterEvent, itemNameRetryFrame, "BAG_UPDATE")
itemNameRetryFrame:SetScript("OnEvent", function()
local retry
for lname in pairs(itemNameMissAt) do
retry = retry or {}
table.insert(retry, lname)
end
if not retry then return end
local resolved = false
for i = 1, table.getn(retry) do
-- Clear the rate-limit stamp: a bag change is exactly the event that can
-- make this walk succeed, so it should not be waited out.
itemNameMissAt[retry[i]] = nil
if WA.ItemIDByName(retry[i]) then resolved = true end
end
if resolved and WA.AddAllDisplays then WA.AddAllDisplays() end
end)
function WA.ResolveItemID(input)
if input == nil or input == "" then return nil end
local id = tonumber(input)
if id then return id end
-- A shift-clicked link (or any "item:N" string) carries the id outright,
-- which is the one form needing neither the item cache nor a scan.
local _, _, linkId = string.find(input, "item:(%d+)")
if linkId then return tonumber(linkId) end
local name, link = GetItemInfo(input)
if link then
local _, _, capturedId = string.find(link, "item:(%d+)")
local id2 = capturedId and tonumber(capturedId)
if id2 then return id2 end
end
local byName = WA.ItemIDByName(input)
if byName == nil then noteUnresolved() end
return byName
end
-- Inspect the player's equipment and return the first matching item's details.
-- GetItemInfoInstant is cache-only: an ID can be present while its class data
-- is unavailable, so an uncached item is equipped but cannot match a type.
function WA.ItemTypeEquipped(wantedClassID, wantedSubclassID, selectedSlot)
local firstSeen
local firstID, firstName, firstIcon, firstClass, firstSubclass
local firstClassID, firstSubclassID, firstKnown
local matchingID, matchingName, matchingIcon, matchingClass, matchingSubclass
local matchingClassID, matchingSubclassID
local equipped = false
local startSlot, endSlot = 1, 19
if selectedSlot and tonumber(selectedSlot) and tonumber(selectedSlot) > 0 then
startSlot, endSlot = tonumber(selectedSlot), tonumber(selectedSlot)
end
for slot = startSlot, endSlot do
local id = GetInventoryItemID and GetInventoryItemID("player", slot)
if id then
equipped = true
local itemID, itemClass, itemSubclass, _, itemIcon, classID, subclassID
if C_Item and C_Item.GetItemInfoInstant then
itemID, itemClass, itemSubclass, _, itemIcon, classID, subclassID = C_Item.GetItemInfoInstant(id)
end
local known = itemID and classID ~= nil and subclassID ~= nil
if not firstSeen then firstID = itemID or id end
if known then
local itemName, cachedIcon
if C_Item and C_Item.GetItemInfo then
itemName, _, _, _, _, _, _, _, _, cachedIcon = C_Item.GetItemInfo(itemID)
end
itemIcon = itemIcon or cachedIcon
if not firstKnown and not firstSeen then
firstName, firstIcon = itemName, itemIcon
firstClass, firstSubclass = itemClass, itemSubclass
firstClassID, firstSubclassID, firstKnown = classID, subclassID, true
end
if not matchingID and classID == tonumber(wantedClassID) and subclassID == tonumber(wantedSubclassID) then
matchingID, matchingName, matchingIcon = itemID, itemName, itemIcon
matchingClass, matchingSubclass = itemClass, itemSubclass
matchingClassID, matchingSubclassID = classID, subclassID
end
elseif not firstSeen then
firstID = itemID or id
end
firstSeen = true
end
end
if matchingID then
return matchingID, matchingName, matchingIcon, matchingClass, matchingSubclass,
matchingClassID, matchingSubclassID, equipped, true, true
end
return firstID, firstName, firstIcon, firstClass, firstSubclass,
firstClassID, firstSubclassID, equipped, false, firstKnown and true or false
end
function WA.ItemSetEquipped(setID)
local targetID = tonumber(setID) or 0
local total = 18
local count = 0
local setName
local known = false
if C_Item and C_Item.GetItemSetInfo then
local info = C_Item.GetItemSetInfo(targetID)
if info then
setName = info.name
known = true
end
end
if targetID > 0 and C_Item and C_Item.GetItemSetIDByID and GetInventoryItemID then
for slot = 1, 18 do
local itemID = GetInventoryItemID("player", slot)
local equippedSetID = itemID and C_Item.GetItemSetIDByID(itemID)
if equippedSetID == targetID then count = count + 1 end
end
end
return count, total, setName, known
end
function WA.EquipmentSetInfo(setName, partial)
setName = setName or ""
if C_EquipmentSet and C_EquipmentSet.GetEquipmentSetID
and C_EquipmentSet.GetEquipmentSetInfo then
local setID = C_EquipmentSet.GetEquipmentSetID(setName)
if setID then
local name, icon, _, isEquipped, numItems, numEquipped, _, _, numIgnored =
C_EquipmentSet.GetEquipmentSetInfo(setID)
if name then
numItems = tonumber(numItems) or 0
numEquipped = tonumber(numEquipped) or 0
numIgnored = tonumber(numIgnored) or 0
local active = (partial and numItems > 0 and numEquipped > 0)
or ((not partial) and isEquipped and true or false)
return name, icon, numEquipped, numItems, active and true or false, setID, numIgnored
end
end
end
-- ItemRack is name-keyed and has no numeric set ID. Prefer the
-- ClassicAPI/pfUI set when both systems contain the same name.
if ItemRack_GetUserSets then
local sets = ItemRack_GetUserSets()
local set = sets and sets[setName]
if set then
local total, count = 0, 0
for slot = 0, 19 do
local entry = set[slot]
if entry then
total = total + 1
local equippedID = GetInventoryItemID and GetInventoryItemID("player", slot)
if equippedID and tonumber(entry.id) == tonumber(equippedID) then count = count + 1 end
end
end
local active
if partial then active = total > 0 and count > 0
elseif ItemRack_IsSetEquipped then active = ItemRack_IsSetEquipped(setName) and true or false
else active = total > 0 and count == total end
return setName, set.icon, count, total, active and true or false, nil, 0
end
end
return nil, nil, 0, 0, false
end
-- How many of an item the player holds, plus whether the item was identified at
-- all. Resolved at run time rather than baked into the generated source like
-- other trigger constants: an item can be configured long before one is ever
-- carried, and a typed name only becomes resolvable once one is found.
function WA.ItemCount(input, includeBank)
local id = WA.ResolveItemID(input)
if not id then return 0, false end
if not (C_Item and C_Item.GetItemCount) then return 0, true end
return C_Item.GetItemCount(id, includeBank and true or false) or 0, true
end
-- Bool condition/filter for "is `unit` in range of this spell", unit defaulting
-- to "target" for the spell-cooldown caller. SpellHasRange gates self-buffs and
-- other unrestricted spells to always-true rather than gating on a unit the
-- spell was never range-limited against; UnitInRange is the ClassicAPI 40yd
-- position check. Real Lua (not generated source) since neither call needs
-- per-trigger config.
function WA.SpellInRange(spellId, unit)
unit = unit or "target"
local hasRange = C_Spell and C_Spell.SpellHasRange and C_Spell.SpellHasRange(spellId)
if not hasRange then return true end
if not UnitExists(unit) then return false end
if not UnitInRange then return true end -- can't check on this build; don't gate
return UnitInRange(unit) and true or false
end
-- The unit token a trigger actually targets: the dropdown's choice, or the
-- free-text override when the dropdown's "specific" entry is selected (raid17,
-- partyN, or a SuperWoW GUID). Resolved at compile time and baked into the
-- generated source, like every other trigger constant.
function WA.TriggerUnit(trigger, fallback)
if trigger.unit == "specific" then
if trigger.specificUnit and trigger.specificUnit ~= "" then
return trigger.specificUnit
end
return fallback or "player"
end
return trigger.unit or fallback or "player"
end
-- GetItemInfo's classic 14-tuple; only name (1st) and icon (10th) matter to
-- the item-keyed prototypes below.
-- C_Item.GetItemInfo, not the stock global: the global answers vanilla's short
-- tuple, which has no itemLevel and so puts the texture one slot earlier than
-- the modern 18-value shape documents. Reading position 10 off the global gets
-- nil, which is why an item trigger drew no icon.
local function itemNameIcon(id)
if not id then return nil, nil end
if not (C_Item and C_Item.GetItemInfo) then return nil, nil end
local name, _, _, _, _, _, _, _, _, icon = C_Item.GetItemInfo(id)
return name, icon
end
-- Shared 1s heartbeat: some status prototypes hold a value that depletes with no
-- natural game event (a weapon enchant's remaining time, a crowd-control debuff's
-- countdown-to-expiry). They list "WA_SLOW_TICK" in their events and call this in
-- loadFunc; the ticker starts once and re-dispatches through ScanEvents so those
-- triggers re-read live state ~1x/sec (the region itself animates the countdown;
-- this is only to flip show=false at expiry and re-detect a fresh application).
local slowTicker
function WA.EnsureSlowTick()
if not slowTicker then
slowTicker = C_Timer.NewTicker(1, function() WA.ScanEvents("WA_SLOW_TICK") end)
end
end
-- Shared 0.1s heartbeat for status prototypes tracking a fast-moving value
-- (range to a unit). Started lazily by WA.EnsureFastTick when such a trigger
-- loads and never cancelled; a range readout wants smoother than the 1s slow
-- tick, and 0.1s is cheap because ScanEvents early-outs on an event no trigger
-- is registered for.
local fastTicker
function WA.EnsureFastTick()
if not fastTicker then
fastTicker = C_Timer.NewTicker(0.1, function() WA.ScanEvents("WA_FAST_TICK") end)
end
end
-- Temporary weapon enchant (oils/stones/poisons) for one hand. C_Item.
-- GetWeaponEnchantInfo returns a flat 12-tuple (main/off/ranged x has/expireMs/
-- charges/enchantID) -- captured whole via a plain multi-assign, never an
-- `and`-chain (which truncates multi-returns to one value on this client's Lua
-- 5.0). expireMs is remaining time in ms; the API gives no *original* duration,
-- so weCache remembers the remaining seen when the enchant first appeared (reset
-- when it drops or is re-applied -- expiration jumps up) to drive a proper
-- depleting bar rather than a permanently-full one.
local weCache = {}
function WA.WeaponEnchantInfo(hand)
if not (C_Item and C_Item.GetWeaponEnchantInfo) then return false, 0, 0, nil end
local hM, eM, cM, idM, hO, eO, cO, idO, hR, eR, cR, idR = C_Item.GetWeaponEnchantInfo()
local has, expireMs, enchantId
if hand == "off" then has, expireMs, enchantId = hO, eO, idO
elseif hand == "ranged" then has, expireMs, enchantId = hR, eR, idR
else has, expireMs, enchantId = hM, eM, idM end
if not has then weCache[hand] = nil; return false, 0, 0, nil end
local remaining = (expireMs or 0) / 1000
local expiration = GetTime() + remaining
local c = weCache[hand]
if not c or expiration > c.expiration + 2 then
c = { expiration = expiration, duration = remaining }
weCache[hand] = c
else
c.expiration = expiration
end
return true, expiration, c.duration, enchantId
end
-- Reputation standing for a named faction. Walks the displayed faction list
-- (headers skipped) since GetFactionInfoByID needs an ID the user doesn't know;
-- niche enough that an O(n) scan on the UPDATE_FACTION event is fine. barMin/
-- barMax/barValue bracket the current standing bar. nil when the faction isn't
-- in the player's list (not yet encountered).
function WA.FactionStanding(name)
if not name or name == "" or not GetNumFactions then return nil end
for i = 1, GetNumFactions() do
local fname, _, standingID, barMin, barMax, barValue, _, _, isHeader = GetFactionInfo(i)
if not isHeader and fname == name then
return standingID, barMin, barMax, barValue, fname
end
end
return nil
end
-- Crowd-control category table (English spell names -> category), adapted from
-- the reference LoseControl addon's Babble-Spell keyed table. On an English
-- client Babble-Spell is identity, so those keys ARE the plain spell names --
-- reproduced here directly since we ship no Babble-Spell. Categories match
-- LoseControl's (stuns/incapacitates/fears all fold into "CC"); a couple of its
-- entries that aren't really control effects (e.g. Mortal Strike, a heal debuff)
-- are dropped so a CC display doesn't false-positive on them.
local CC_CATEGORIES = {
-- Druid
["Hibernate"] = "CC", ["Bash"] = "CC", ["Pounce"] = "CC", ["Feral Charge Effect"] = "Root",
["Entangling Roots"] = "Root",
-- Hunter
["Freezing Trap Effect"] = "CC", ["Intimidation"] = "CC", ["Scare Beast"] = "CC",
["Scatter Shot"] = "CC", ["Wyvern Sting"] = "CC", ["Concussive Shot"] = "Snare",
["Frost Trap Aura"] = "Root", ["Counterattack"] = "Root", ["Improved Wing Clip"] = "Root",
["Wing Clip"] = "Snare", ["Entrapment"] = "Root",
-- Mage
["Polymorph"] = "CC", ["Polymorph: Turtle"] = "CC", ["Polymorph: Pig"] = "CC",
["Counterspell - Silenced"] = "Silence", ["Impact"] = "CC", ["Blast Wave"] = "Snare",
["Frostbite"] = "Root", ["Freeze"] = "Root", ["Frost Nova"] = "Root",
["Frostbolt"] = "Snare", ["Chilled"] = "Snare", ["Cone of Cold"] = "Snare",
-- Paladin
["Hammer of Justice"] = "CC", ["Repentance"] = "CC",
-- Priest
["Mind Control"] = "CC", ["Psychic Scream"] = "CC", ["Blackout"] = "CC",
["Silence"] = "Silence", ["Mind Flay"] = "Snare",
-- Rogue
["Blind"] = "CC", ["Cheap Shot"] = "CC", ["Gouge"] = "CC", ["Kidney Shot"] = "CC",
["Sap"] = "CC", ["Kick - Silenced"] = "Silence", ["Crippling Poison"] = "Snare",
-- Warlock
["Death Coil"] = "CC", ["Fear"] = "CC", ["Howl of Terror"] = "CC",
["Curse of Exhaustion"] = "Snare", ["Seduction"] = "CC", ["Spell Lock"] = "Silence",
["Aftermath"] = "Snare", ["Cripple"] = "Snare",
-- Warrior
["Charge Stun"] = "CC", ["Intercept Stun"] = "CC", ["Intimidating Shout"] = "CC",
["Concussion Blow"] = "CC", ["Piercing Howl"] = "Snare",
["Shield Bash - Silenced"] = "Silence", ["Disarm"] = "Disarm",
-- Other / creature
["War Stomp"] = "CC", ["Mace Stun Effect"] = "CC", ["Web"] = "Root", ["Net"] = "Root",
["Knockdown"] = "CC", ["Sleep"] = "CC", ["Dazed"] = "Snare", ["Tidal Charm"] = "CC",
["Gnomish Mind Control Cap"] = "CC",
}
-- First crowd-control debuff on the player, or (false, ...). Player-unit aura
-- timing is the reliable path on this client (real duration/expiration only for
-- unit == "player"), which is exactly what a "am I CC'd" display
-- needs. Scans HARMFUL and stops at the first nil slot (compacting list).
function WA.ScanPlayerCC()
if not (C_UnitAuras and C_UnitAuras.GetAuraDataByIndex) then return false end
for i = 1, 40 do
local aura = C_UnitAuras.GetAuraDataByIndex("player", i, "HARMFUL")
if not aura then break end
local cat = aura.name and CC_CATEGORIES[aura.name]
if cat then
return true, cat, aura.name, aura.icon, aura.expirationTime or 0, aura.duration or 0
end
end
return false, nil, nil, nil, 0, 0
end
-- ---------------------------------------------------------------------------
-- Prototypes (§4). Each = one table; adding a category never touches the
-- system code above or below.
-- ---------------------------------------------------------------------------
local PROTOTYPES = {}
-- A saved trigger field written under an older name, moved in place. Reached
-- through the trigger type's `migrate` hook, which MergeDefaults runs on every
-- load before seeding defaults -- so it has to stay idempotent and must not
-- overwrite a value already stored under the new name.
local function renameArg(trigger, old, new)
if trigger[old] == nil then return end
if trigger[new] == nil then trigger[new] = trigger[old] end
trigger[old] = nil
end
local COMBAT_EVENT_VALUES = { "PLAYER_REGEN_DISABLED", "PLAYER_REGEN_ENABLED" }
local COMBAT_EVENT_LABELS = {
PLAYER_REGEN_DISABLED = "Entering Combat",
PLAYER_REGEN_ENABLED = "Leaving Combat",
}
local CHAT_MESSAGE_VALUES = {
"CHAT_MSG_SAY", "CHAT_MSG_PARTY", "CHAT_MSG_RAID", "CHAT_MSG_GUILD",
"CHAT_MSG_OFFICER", "CHAT_MSG_YELL", "CHAT_MSG_WHISPER", "CHAT_MSG_EMOTE",
"CHAT_MSG_SYSTEM", "CHAT_MSG_MONSTER_SAY",
"CHAT_MSG_MONSTER_YELL", "CHAT_MSG_MONSTER_WHISPER", "CHAT_MSG_MONSTER_EMOTE",
"CHAT_MSG_CHANNEL", "CHAT_MSG_LOOT", "CHAT_MSG_RAID_WARNING",
"CHAT_MSG_BG_SYSTEM_NEUTRAL", "CHAT_MSG_BG_SYSTEM_ALLIANCE", "CHAT_MSG_BG_SYSTEM_HORDE",
}
local CHAT_MESSAGE_LABELS = {}
for i = 1, table.getn(CHAT_MESSAGE_VALUES) do
local value = CHAT_MESSAGE_VALUES[i]
CHAT_MESSAGE_LABELS[value] = string.sub(value, 10)
end
local CHAT_MESSAGE_ALL_EVENTS = {}
for i = 1, table.getn(CHAT_MESSAGE_VALUES) do table.insert(CHAT_MESSAGE_ALL_EVENTS, CHAT_MESSAGE_VALUES[i]) end
table.insert(CHAT_MESSAGE_ALL_EVENTS, "CHAT_MSG_PARTY_LEADER")
table.insert(CHAT_MESSAGE_ALL_EVENTS, "CHAT_MSG_RAID_LEADER")
table.insert(CHAT_MESSAGE_ALL_EVENTS, "CHAT_MSG_TEXT_EMOTE")
local function chatMessageEvents(trigger)
if trigger and trigger.use_messageType and trigger.messageType and CHAT_MESSAGE_LABELS[trigger.messageType] then
local events = { trigger.messageType }
if trigger.messageType == "CHAT_MSG_PARTY" then table.insert(events, "CHAT_MSG_PARTY_LEADER") end
if trigger.messageType == "CHAT_MSG_RAID" then table.insert(events, "CHAT_MSG_RAID_LEADER") end
if trigger.messageType == "CHAT_MSG_EMOTE" then table.insert(events, "CHAT_MSG_TEXT_EMOTE") end
return events
end
return CHAT_MESSAGE_ALL_EVENTS
end
function WA.TalentInfo(wanted, wantedTab, wantedTier, wantedColumn)
if not (GetNumTalentTabs and GetNumTalents and GetTalentInfo) then return false, false, 0, 0, 0, 0, 0, nil, nil end
if not wanted or wanted == "" then return false, false, 0, 0, 0, 0, 0, nil, nil end
local tabs = tonumber(GetNumTalentTabs()) or 0
for tab = 1, tabs do
if wantedTab == 0 or wantedTab == tab then
local count = tonumber(GetNumTalents(tab)) or 0
for index = 1, count do
local name, icon, tier, column, rank, maxRank = GetTalentInfo(tab, index)
if name == wanted
and (wantedTier == 0 or tier == wantedTier)
and (wantedColumn == 0 or column == wantedColumn) then
return true, (tonumber(rank) or 0) > 0, tonumber(rank) or 0,
tonumber(maxRank) or 0, tab, tonumber(tier) or 0, tonumber(column) or 0, icon
end
end
end
end
return false, false, 0, 0, 0, 0, 0, nil, nil
end
function WA.PetBehavior()
if not GetPetActionInfo then return nil, nil end
local slots = NUM_PET_ACTION_SLOTS or 10
for index = 1, slots do
local name, _, texture, token, active = GetPetActionInfo(index)
if active and name then
local behavior
if name == "PET_MODE_AGGRESSIVE" then behavior = "aggressive"
elseif name == "PET_MODE_ASSIST" then behavior = "assist"
elseif name == "PET_MODE_DEFENSIVEASSIST" or name == "PET_MODE_DEFENSIVE" then behavior = "defensive"
elseif name == "PET_MODE_PASSIVE" then behavior = "passive" end
if behavior then
if token and texture then texture = _G[texture] end
return behavior, texture
end
end
end
return nil, nil
end
local TALENT_TAB_VALUES = { 0, 1, 2, 3 }
local TALENT_TAB_LABELS = { [0] = "Any Tab", [1] = "Tab 1", [2] = "Tab 2", [3] = "Tab 3" }
local TALENT_RANK_VALUES = { "ignore", "known", "maxed" }
local TALENT_RANK_LABELS = { ignore = "Any Rank", known = "Known (rank > 0)", maxed = "Max Rank" }
PROTOTYPES["talentknown"] = {
displayName = "Talent Known",
wa2Event = "Talent Known",
category = "unit",
progressType = "static",
progressValue = "rank",
progressTotal = "maxRank",
events = function() return { "CHARACTER_POINTS_CHANGED", "SPELLS_CHANGED", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Book_09",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Book_09" end,
nameFunc = function(trigger) return trigger.talentName or "Talent Known" end,
iconFunc = function(trigger)
local _, _, _, _, _, _, _, icon = WA.TalentInfo(trigger.talentName,
(trigger.usePlacement and tonumber(trigger.talentTab)) or 0,
(trigger.usePlacement and tonumber(trigger.talentTier)) or 0,
(trigger.usePlacement and tonumber(trigger.talentColumn)) or 0)
return icon or "Interface\\Icons\\INV_Misc_Book_09"
end,
init = function(trigger)
return "local talentFoundValue, knownValue, rankValue, maxRankValue, talentTabFoundValue, talentTierFoundValue, talentColumnFoundValue, talentIconValue = WeakestAuras.TalentInfo("
.. fmt(trigger.talentName or "") .. ", " .. tostring(tonumber(trigger.talentTab) or 0) .. ", "
.. tostring(tonumber(trigger.talentTier) or 0) .. ", " .. tostring(tonumber(trigger.talentColumn) or 0) .. ")"
end,
args = {
{ name = "talentName", type = "talent", display = "Talent Name", required = true },
{ name = "usePlacement", type = "toggle", display = "Advanced Placement Filters", default = false, reloadOptions = true },
{ name = "talentTab", type = "select", required = true, display = "Talent Tab",
valueList = TALENT_TAB_VALUES, valueLabels = TALENT_TAB_LABELS, default = 0,
enable = function(trigger) return trigger.usePlacement end,
reloadOptions = true, test = function() return nil end },
{ name = "talentTier", type = "range", display = "Tier", min = 0, max = 10, step = 1, default = 0,
enable = function(trigger) return trigger.usePlacement end,
reloadOptions = true, test = function() return nil end },
{ name = "talentColumn", type = "range", display = "Column", min = 0, max = 4, step = 1, default = 0,
enable = function(trigger) return trigger.usePlacement end,
reloadOptions = true, test = function() return nil end },
{ name = "rankMode", type = "select", required = true, display = "Rank",
valueList = TALENT_RANK_VALUES, valueLabels = TALENT_RANK_LABELS, default = "ignore", reloadOptions = true,
test = function(trigger)
if trigger.rankMode == "known" then return "(talentFound and known)" end
if trigger.rankMode == "maxed" then return "(known and rank >= maxRank)" end
return "talentFound"
end },
{ name = "talentFound", type = "hidden", init = "talentFoundValue", store = true, conditionType = "bool", display = "Talent Found" },
{ name = "known", type = "hidden", init = "knownValue", store = true, conditionType = "bool", display = "Known" },
{ name = "rank", type = "hidden", init = "rankValue", store = true, conditionType = "number", display = "Rank" },
{ name = "maxRank", type = "hidden", init = "maxRankValue", store = true, conditionType = "number", display = "Max Rank" },
{ name = "talentTabFound", type = "hidden", init = "talentTabFoundValue", store = true, conditionType = "number", display = "Tab" },
{ name = "talentTierFound", type = "hidden", init = "talentTierFoundValue", store = true, conditionType = "number", display = "Tier" },
{ name = "talentColumnFound", type = "hidden", init = "talentColumnFoundValue", store = true, conditionType = "number", display = "Column" },
{ name = "icon", type = "hidden", init = "talentIconValue", store = true },
},
}
local CONDITION_STATUS_LABELS = { ignore = "Ignore", ["true"] = "Yes", ["false"] = "No" }
local CONDITION_STATUS_VALUES = { "ignore", "true", "false" }
local function conditionStatusTest(name)
return function(trigger)
local value = trigger[name] or "ignore"
if value == "ignore" then return nil end
return value == "true" and name or "not " .. name
end
end
local function addConditionEvent(events, seen, eventName)
if not seen[eventName] then
seen[eventName] = true
table.insert(events, eventName)
end
end
local function conditionEvents(trigger)
local out, seen = {}, {}
addConditionEvent(out, seen, "PLAYER_ENTERING_WORLD")
if trigger.incombat ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_REGEN_ENABLED")
addConditionEvent(out, seen, "PLAYER_REGEN_DISABLED")
end
if trigger.alive ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_DEAD")
addConditionEvent(out, seen, "PLAYER_ALIVE")
addConditionEvent(out, seen, "PLAYER_UNGHOST")
end
if trigger.onTaxi ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_CONTROL_LOST")
addConditionEvent(out, seen, "PLAYER_CONTROL_GAINED")
end
if trigger.resting ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_UPDATE_RESTING")
end
if trigger.mounted ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_AURAS_CHANGED")
addConditionEvent(out, seen, "PLAYER_MOUNT_DISPLAY_CHANGED")
end
if trigger.hasPet ~= "ignore" then
addConditionEvent(out, seen, "UNIT_PET")
end
if trigger.isMoving ~= "ignore" then
addConditionEvent(out, seen, "WA_FAST_TICK")
end
if trigger.afk ~= "ignore" or trigger.pvpFlagged ~= "ignore" then
addConditionEvent(out, seen, "PLAYER_FLAGS_CHANGED")
end
if trigger.groupType ~= "ignore" then
addConditionEvent(out, seen, "GROUP_ROSTER_UPDATE")
addConditionEvent(out, seen, "PARTY_MEMBERS_CHANGED")
addConditionEvent(out, seen, "RAID_ROSTER_UPDATE")
end
if trigger.instanceType ~= "ignore" then
addConditionEvent(out, seen, "ZONE_CHANGED")
addConditionEvent(out, seen, "ZONE_CHANGED_INDOORS")
addConditionEvent(out, seen, "ZONE_CHANGED_NEW_AREA")
end
return out
end
local function conditionStatusArg(name, display, init)
return { name = name, type = "select", required = true, display = display,
valueList = CONDITION_STATUS_VALUES, valueLabels = CONDITION_STATUS_LABELS,
default = "ignore", init = init, store = true, conditionType = "bool",
test = conditionStatusTest(name) }
end
local CONDITION_VALUE_LABELS = {
groupType = { ignore = "Ignore", any = "Any Group (Party/Raid)", solo = "Solo", party = "Party", raid = "Raid" },
instanceType = { ignore = "Ignore", none = "Outside Instance", dungeon = "Dungeon",
raid = "Raid", pvp = "Battleground", arena = "Arena" },
}
local function conditionValueTest(name)
return function(trigger)
local value = trigger[name] or "ignore"
if value == "ignore" then return nil end
if name == "groupType" and value == "any" then return "groupType ~= \"solo\"" end
return string.format("%s == %q", name, value)
end
end
function WA.ConditionGroupType()
if GetNumRaidMembers and (GetNumRaidMembers() or 0) > 0 then return "raid" end
if GetNumPartyMembers and (GetNumPartyMembers() or 0) > 0 then return "party" end
return "solo"
end
function WA.ConditionInstanceType()
if not IsInInstance then return "none" end
local inside, raw = IsInInstance()
if not inside then return "none" end
if raw == "party" then return "dungeon" end
return raw or "none"
end
local function conditionValueArg(name, display, values, labels, init)
return { name = name, type = "select", required = true, display = display,
valueList = values, valueLabels = labels, default = "ignore", init = init,
test = conditionValueTest(name), store = true, conditionType = "string" }
end
PROTOTYPES["conditions"] = {
displayName = "Conditions",
wa2Event = "Conditions",
category = "unit",
progressType = "none",
events = conditionEvents,
force_events = true,
loadFunc = function(trigger)
if trigger.isMoving ~= "ignore" then WA.EnsureFastTick() end
end,
icon = "Interface\\Icons\\Spell_Holy_PowerInfusion",
iconFunc = function() return "Interface\\Icons\\Spell_Holy_PowerInfusion" end,
nameFunc = function() return "Conditions" end,
init = function() return "" end,
args = {
conditionStatusArg("alwaystrue", "Always Active", "true"),
conditionStatusArg("incombat", "In Combat", "UnitAffectingCombat(\"player\") and true or false"),
conditionStatusArg("alive", "Alive", "(not UnitIsDeadOrGhost(\"player\")) and true or false"),
conditionStatusArg("onTaxi", "On Taxi", "(UnitOnTaxi and UnitOnTaxi(\"player\")) and true or false"),
conditionStatusArg("resting", "Resting", "(IsResting and IsResting()) and true or false"),
conditionStatusArg("mounted", "Mounted", "(IsMounted and IsMounted()) and true or false"),
conditionStatusArg("hasPet", "Has Pet", "(UnitExists(\"pet\") and not UnitIsDeadOrGhost(\"pet\")) and true or false"),
conditionStatusArg("isMoving", "Is Moving", "((GetUnitSpeed and GetUnitSpeed(\"player\")) or 0) > 0"),
conditionStatusArg("afk", "AFK", "(UnitIsAFK and UnitIsAFK(\"player\")) and true or false"),
conditionStatusArg("pvpFlagged", "PvP Flagged", "((UnitIsPVP and UnitIsPVP(\"player\")) or (UnitIsPVPFreeForAll and UnitIsPVPFreeForAll(\"player\"))) and true or false"),
conditionValueArg("groupType", "Group Type", { "ignore", "any", "solo", "party", "raid" }, CONDITION_VALUE_LABELS.groupType, "WeakestAuras.ConditionGroupType()"),
conditionValueArg("instanceType", "Instance Type", { "ignore", "none", "dungeon", "raid", "pvp", "arena" }, CONDITION_VALUE_LABELS.instanceType, "WeakestAuras.ConditionInstanceType()"),
},
}
local LOCATION_INSTANCE_VALUES = { "ignore", "none", "party", "raid", "pvp", "arena" }
local LOCATION_INSTANCE_LABELS = { ignore = "Ignore", none = "Outside Instance", party = "Dungeon", raid = "Raid", pvp = "Battleground", arena = "Arena" }
PROTOTYPES["location"] = {
displayName = "Location",
wa2Event = "Location",
category = "unit",
progressType = "none",
events = function() return { "ZONE_CHANGED", "ZONE_CHANGED_INDOORS", "ZONE_CHANGED_NEW_AREA", "MINIMAP_ZONE_CHANGED", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Map_01",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Map_01" end,
nameFunc = function() return "Location" end,
init = function()
return "local zoneValue = (GetRealZoneText and GetRealZoneText()) or (GetZoneText and GetZoneText()) or \"\"\n"
.. "local subzoneValue = (GetSubZoneText and GetSubZoneText()) or \"\"\n"
.. "local instanceNameValue, _, _, _, instanceTypeValue\n"
.. "if GetInstanceInfo then instanceNameValue, _, _, _, instanceTypeValue = GetInstanceInfo() end\n"
.. "instanceNameValue = instanceNameValue or \"\"\n"
.. "instanceTypeValue = instanceTypeValue or \"none\""
end,
args = {
{ name = "zone", type = "hidden", display = "Zone", init = "zoneValue", store = true, conditionType = "string" },
{ name = "subzone", type = "hidden", display = "Subzone", init = "subzoneValue", store = true, conditionType = "string" },
{ name = "instanceName", type = "hidden", display = "Instance Name", init = "instanceNameValue", store = true, conditionType = "string" },
{ name = "zoneFilter", type = "text", display = "Zone Filter", default = "", test = function(trigger)
if not trigger.zoneFilter or trigger.zoneFilter == "" then return nil end
return "string.lower(zoneValue) == string.lower(" .. fmt(trigger.zoneFilter) .. ")"
end },
{ name = "subzoneFilter", type = "text", display = "Subzone Filter", default = "", test = function(trigger)
if not trigger.subzoneFilter or trigger.subzoneFilter == "" then return nil end
return "string.lower(subzoneValue) == string.lower(" .. fmt(trigger.subzoneFilter) .. ")"
end },
{ name = "instanceNameFilter", type = "text", display = "Instance Name Filter", default = "", test = function(trigger)
if not trigger.instanceNameFilter or trigger.instanceNameFilter == "" then return nil end
return "string.lower(instanceNameValue) == string.lower(" .. fmt(trigger.instanceNameFilter) .. ")"
end },
{ name = "instanceType", type = "hidden", init = "instanceTypeValue", store = true, conditionType = "string", display = "Instance Type" },
{ name = "instanceTypeFilter", type = "select", display = "Instance Type", valueList = LOCATION_INSTANCE_VALUES, valueLabels = LOCATION_INSTANCE_LABELS,
default = "ignore", test = function(trigger)
if not trigger.use_instanceTypeFilter or trigger.instanceTypeFilter == "ignore" then return nil end
return "instanceTypeValue == " .. fmt(trigger.instanceTypeFilter)
end },
},
}
PROTOTYPES["money"] = {
displayName = "Money",
wa2Event = "Money",
category = "unit",
progressType = "none",
events = function() return { "PLAYER_MONEY", "WA_DELAYED_PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Coin_01",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Coin_01" end,
nameFunc = function() return "Money" end,
init = function()
return "local money = GetMoney() or 0\n"
.. "local gold = math.floor(money / 10000)\n"
.. "local silver = math.mod(math.floor(money / 100), 100)\n"
.. "local copper = math.mod(money, 100)"
end,
args = {
{ name = "money", type = "hidden", required = true, init = "money",
store = true, conditionType = "number", display = "Money" },
{ name = "gold", type = "hidden", required = true, init = "gold",
store = true, conditionType = "number", display = "Gold" },
{ name = "silver", type = "hidden", required = true, init = "silver",
store = true, conditionType = "number", display = "Silver" },
{ name = "copper", type = "hidden", required = true, init = "copper",
store = true, conditionType = "number", display = "Copper" },
},
}
local PET_BEHAVIOR_VALUES = { "aggressive", "assist", "defensive", "passive" }
local PET_BEHAVIOR_LABELS = { aggressive = "Aggressive", assist = "Assist", defensive = "Defensive", passive = "Passive" }
PROTOTYPES["petbehavior"] = {
displayName = "Pet Behavior",
wa2Event = "Pet Behavior",
category = "unit",
progressType = "none",
events = function() return { "PET_BAR_UPDATE", "UNIT_PET", "WA_DELAYED_PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\Ability_Hunter_MendPet",
iconFunc = function() return "Interface\\Icons\\Ability_Hunter_MendPet" end,
nameFunc = function() return "Pet" end,
init = function()
return "local petBehaviorValue, petIconValue = WeakestAuras.PetBehavior()"
end,
args = {
{ name = "behavior", type = "select", required = true, display = "Pet Behavior",
valueList = PET_BEHAVIOR_VALUES, valueLabels = PET_BEHAVIOR_LABELS, default = "aggressive",
test = function(trigger)
if trigger.inverse then return "petBehaviorValue ~= " .. fmt(trigger.behavior) end
return "petBehaviorValue == " .. fmt(trigger.behavior)
end },
{ name = "inverse", type = "toggle", display = "Inverse" },
{ name = "petExists", type = "hidden", required = true, init = "UnitExists(\"pet\") and true or false",
store = true, conditionType = "bool", display = "Has Pet", test = "petExists" },
{ name = "behaviorValue", type = "hidden", init = "petBehaviorValue",
store = true, conditionType = "string", display = "Current Behavior" },
{ name = "icon", type = "hidden", init = "petIconValue", store = true },
},
}
PROTOTYPES["queuedaction"] = {
displayName = "Queued Action",
wa2Event = "Queued Action",
category = "spell",
progressType = "none",
events = function() return { "ACTIONBAR_UPDATE_STATE", "ACTIONBAR_SLOT_CHANGED", "CURRENT_SPELL_CAST_CHANGED", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_QuestionMark",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if id then
local _, _, icon = GetSpellInfo(id)
return icon or "Interface\\Icons\\INV_Misc_QuestionMark"
end
return "Interface\\Icons\\INV_Misc_QuestionMark"
end,
nameFunc = function(trigger) return trigger.spellName or "Queued Action" end,
init = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName) or 0
return "local spellId = " .. fmt(id) .. "\n"
.. "local queuedValue = C_Spell and C_Spell.IsCurrentSpell and C_Spell.IsCurrentSpell(spellId) and true or false"
end,
args = {
{ name = "spellName", type = "spell", display = "Spell", required = true },
{ name = "queued", type = "hidden", required = true, init = "queuedValue", test = "queued",
store = true, conditionType = "bool", display = "Queued" },
},
}
-- Combat status: shown while the player is in combat. No user config.
PROTOTYPES["combat"] = {
displayName = "In Combat",
category = "unit",
progressType = "none",
events = function() return { "PLAYER_REGEN_ENABLED", "PLAYER_REGEN_DISABLED", "PLAYER_TARGET_CHANGED" } end,
force_events = true,
icon = "Interface\\Icons\\Ability_DualWield",
iconFunc = function() return "Interface\\Icons\\Ability_DualWield" end,
nameFunc = function() return "In Combat" end,
init = function()
return "local incombat = UnitAffectingCombat(\"player\") and true or false\n"
.. "local hastarget = UnitExists(\"target\") and true or false\n"
.. "local attackabletarget = (UnitExists(\"target\") and UnitCanAttack(\"player\", \"target\")) and true or false"
end,
args = {
{ name = "incombat", type = "hidden", required = true, test = "incombat",
store = true, conditionType = "bool", display = "In Combat" },
-- Optional filters: require a (attackable) target as well as combat.
{ name = "hastarget", type = "toggle", display = "Has Target",
test = function(t) return t.hastarget and "hastarget" or nil end },
{ name = "attackabletarget", type = "toggle", display = "Attackable Target",
test = function(t) return t.attackabletarget and "attackabletarget" or nil end },
},
}
-- A `statesParameter = "unit"` prototype offers WA.multi_unit_tokens beside the
-- single tokens: one clone per member, keyed by GUID rather than by upstream's
-- positional token (§4.3).
local multiUnitFamily = WA.MultiUnitFamily
-- Membership churn for a family, appended to whatever unit events the prototype
-- reads: those say a member changed, these say which members there are.
local function appendMultiUnitEvents(trigger, out)
local family = multiUnitFamily(trigger)
if not family then return out end
if family == "nameplate" then
table.insert(out, "NAME_PLATE_UNIT_ADDED")
table.insert(out, "NAME_PLATE_UNIT_REMOVED")
else
table.insert(out, "PARTY_MEMBERS_CHANGED")
table.insert(out, "RAID_ROSTER_UPDATE")
end
table.insert(out, "PLAYER_ENTERING_WORLD")
return out
end
-- Multi-unit init: the runner hands the member's live token in as arg1, so the
-- generated source reads it instead of a compile-time constant.
local function multiUnitInit(trigger, fallback)
if multiUnitFamily(trigger) then return "local unit = arg1" end
return "local unit = " .. fmt(WA.TriggerUnit(trigger, fallback))
end
local function multiUnitName(trigger, fallback)
local family = multiUnitFamily(trigger)
if family then return WA.multi_unit_labels[family] end
local unit = WA.TriggerUnit(trigger, fallback)
return UnitName(unit) or unit
end
-- Unit health, static progress (value/total = health/maxhealth).
PROTOTYPES["health"] = {
displayName = "Health",
wa2Event = "Health",
category = "unit",
progressType = "static",
progressValue = "health",
progressTotal = "maxhealth",
events = function(trigger)
return appendMultiUnitEvents(trigger, { "UNIT_HEALTH", "UNIT_MAXHEALTH" })
end,
force_events = true,
statesParameter = "unit",
icon = "Interface\\Icons\\INV_Potion_54",
iconFunc = function() return "Interface\\Icons\\INV_Potion_54" end,
nameFunc = function(trigger) return multiUnitName(trigger, "player") end,
init = function(trigger) return multiUnitInit(trigger, "player") end,
args = {
{ name = "unit", type = "unit", display = "Unit",
valueList = WA.unit_tokens_multi, valueLabels = WA.unit_labels_multi,
store = true, conditionType = "string" },
{ name = "exists", type = "hidden", required = true, test = "UnitExists(unit)" },
{ name = "health", type = "number", display = "Health", init = "UnitHealth(unit)",
multiEntry = true, store = true, conditionType = "number" },
{ name = "maxhealth", type = "hidden", init = "UnitHealthMax(unit)",
store = true, conditionType = "number", display = "Max Health" },
{ name = "percenthealth", type = "number", display = "Health (%)",
init = "(UnitHealthMax(unit) > 0 and (UnitHealth(unit) / UnitHealthMax(unit) * 100) or 0)",
multiEntry = true, store = true, conditionType = "number" },
{ name = "healthDeficit", type = "number", display = "Health Deficit",
init = "(UnitHealthMax(unit) - UnitHealth(unit))",
store = true, conditionType = "number" },
{ name = "name", type = "string", init = "UnitName(unit)",
store = true, conditionType = "string", display = "Name" },
-- UnitInRange is a ClassicAPI backport (a real 40yd position check); guard
-- it so a build without it can't error the whole compiled test. Refreshes
-- on this prototype's health events, not on movement -- a condition var, not
-- a real-time range gate.
{ name = "inRange", type = "hidden", init = "((UnitInRange and UnitInRange(unit)) and true or false)",
store = true, conditionType = "bool", display = "In Range" },
{ name = "ignoreDead", type = "toggle", display = "Ignore Dead",
test = function(t) return t.ignoreDead and "(not UnitIsDead(unit))" or nil end },
{ name = "ignoreDisconnected", type = "toggle", display = "Ignore Disconnected",
test = function(t) return t.ignoreDisconnected and "UnitIsConnected(unit)" or nil end },
{ name = "inRangeFilter", type = "toggle", display = "Only if In Range",
test = function(t) return t.inRangeFilter and "inRange" or nil end },
},
}
-- Unit power (mana/rage/energy -- UnitMana returns the active bar). Static
-- progress. UnitPowerType select filters which resource must be active.
PROTOTYPES["power"] = {
displayName = "Power",
wa2Event = "Power",
category = "unit",
progressType = "static",
progressValue = "power",
progressTotal = "maxpower",
events = function(trigger)
return appendMultiUnitEvents(trigger, { "UNIT_MANA", "UNIT_RAGE", "UNIT_ENERGY", "UNIT_FOCUS",
"UNIT_MAXMANA", "UNIT_MAXRAGE", "UNIT_MAXENERGY", "UNIT_DISPLAYPOWER" })
end,
force_events = true,
statesParameter = "unit",
icon = "Interface\\Icons\\Spell_Nature_Lightning",
iconFunc = function() return "Interface\\Icons\\Spell_Nature_Lightning" end,
nameFunc = function(trigger) return multiUnitName(trigger, "player") end,
init = function(trigger) return multiUnitInit(trigger, "player") end,
args = {
{ name = "unit", type = "unit", display = "Unit",
valueList = WA.unit_tokens_multi, valueLabels = WA.unit_labels_multi,
store = true, conditionType = "string" },
{ name = "exists", type = "hidden", required = true, test = "UnitExists(unit)" },
{ name = "powertype", type = "select", display = "Power Type",
init = "UnitPowerType(unit)",
valueList = { 0, 1, 3, 2 },
valueLabels = { [0] = "Mana", [1] = "Rage", [2] = "Focus", [3] = "Energy" } },
{ name = "power", type = "number", display = "Power", init = "UnitMana(unit)",
store = true, conditionType = "number" },
{ name = "maxpower", type = "hidden", init = "UnitManaMax(unit)",
store = true, conditionType = "number", display = "Max Power" },
{ name = "percentpower", type = "number", display = "Power (%)",
init = "(UnitManaMax(unit) > 0 and (UnitMana(unit) / UnitManaMax(unit) * 100) or 0)",
multiEntry = true, store = true, conditionType = "number" },
{ name = "powerDeficit", type = "number", display = "Power Deficit",
init = "(UnitManaMax(unit) - UnitMana(unit))",
store = true, conditionType = "number" },
{ name = "name", type = "hidden", init = "UnitName(unit)",
store = true, conditionType = "string", display = "Name" },
},
}
-- "Is a real cooldown running", shared by the three cooldown prototypes. The
-- global cooldown passes over every spell and item, so unless `showgcd` asks to
-- keep it, a window no longer than the GCD is not a cooldown of this spell's
-- own. The comparison is against the *measured* GCD (WA.IsGcdCooldown).
local function onCooldownExpr(showgcd)
local notGcd = showgcd and "" or "not WeakestAuras.IsGcdCooldown(duration) and "
return "(duration ~= nil and duration > 0 and " .. notGcd .. "expirationTime > GetTime())"
end
-- Spell cooldown, timed progress. Fed by the central cooldown watcher (below):
-- its init reads the watcher's cache rather than polling GetSpellCooldown
-- itself, so GCD filtering and ready-time scheduling stay in one place (ref
-- §4.4). `genericShowOn` selects whether it shows while on cooldown (default,
-- the old hardwired behavior), while ready, or always (WA2's showOnCheck).
-- The `remaining` arg is shared by the three cooldown prototypes: a
-- remaining-time threshold only means something while the cooldown is running,
-- so in ready mode `remaining` is 0 and any "<=" test would pass -- the arg is
-- hidden and contributes no test there.
local function cooldownRemainingArg()
return { name = "remaining", type = "number", display = "Remaining Time", operator = "<=",
enable = function(trigger) return (trigger.genericShowOn or "showOnCooldown") ~= "showOnReady" end,
test = function(trigger)
if not trigger.use_remaining then return nil end
if (trigger.genericShowOn or "showOnCooldown") == "showOnReady" then return nil end
return string.format("remaining %s %s",
safeOp(trigger.remaining_operator or "<="), fmt(trigger.remaining or 0))
end }
end
PROTOTYPES["spellcooldown"] = {
displayName = "Cooldown Progress (Spell)",
wa2Event = "Cooldown Progress (Spell)",
category = "spell",
progressType = "timed",
-- SPELL_UPDATE_USABLE keeps the usable / insufficient-resources stores live
-- (pcall-guarded registration -- harmless if this build never fires it; the
-- force_events pass + cooldown events still seed them). PLAYER_TARGET_CHANGED
-- re-derives spellInRange on a target swap rather than only on the next
-- cooldown flip; movement in/out of range with the same target refreshes only
-- on this trigger's own event cadence.
events = function() return { "SPELL_COOLDOWN_CHANGED", "SPELL_COOLDOWN_READY", "SPELL_UPDATE_USABLE", "PLAYER_TARGET_CHANGED" } end,
force_events = true,
-- ClassicAPI's GetSpellInfo/GetSpellCooldown only accept a numeric spellID
-- (or slot+bookType) -- unlike vanilla's, there's no name-string lookup
-- form, so every entry point here goes through WA.ResolveSpellID (which
-- does the name->ID resolution the legacy global can't) and falls back
-- cleanly if it doesn't resolve to anything (yet). A `remaining` filter asks
-- the watcher to re-emit while running so the threshold flips near real time.
loadFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if id then WA.WatchSpellCooldown(id, trigger.use_remaining and (trigger.genericShowOn or "showOnCooldown") ~= "showOnReady") end
end,
icon = "Interface\\Icons\\Spell_Holy_BorrowedTime",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return "Interface\\Icons\\Spell_Holy_BorrowedTime" end
local _, _, ic = GetSpellInfo(id)
return ic or "Interface\\Icons\\Spell_Holy_BorrowedTime"
end,
nameFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return (trigger.spellName and trigger.spellName ~= "") and trigger.spellName or "?" end
return GetSpellInfo(id) or trigger.spellName or "?"
end,
init = function(trigger)
return "local spellId = " .. fmt(WA.ResolveSpellID(trigger.spellName) or 0) .. "\n"
.. "local startTime, duration = WeakestAuras.SpellCdInfo(spellId)\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0\n"
.. "local onCooldown = " .. onCooldownExpr(trigger.showgcd) .. " and true or false\n"
.. "local name, _, icon = GetSpellInfo(spellId)\n"
.. "local spellUsable, insufficientResources = false, false\n"
.. "if IsUsableSpell then local _u, _m = IsUsableSpell(spellId) spellUsable = _u and true or false insufficientResources = _m and true or false end\n"
.. "local spellInRange = WeakestAuras.SpellInRange(spellId)"
end,
args = {
{ name = "spellName", type = "spell", display = "Spell" },
{ name = "genericShowOn", type = "select", required = true, display = "Show",
valueList = { "showOnCooldown", "showOnReady", "showAlways" },
valueLabels = { showOnCooldown = "On Cooldown", showOnReady = "Ready", showAlways = "Always" },
default = "showOnCooldown", reloadOptions = true,
test = function(trigger)
local onCd = onCooldownExpr(trigger.showgcd)
local mode = trigger.genericShowOn or "showOnCooldown"
if mode == "showOnReady" then return "not " .. onCd
elseif mode == "showAlways" then return "true"
else return onCd end
end },
{ name = "showgcd", type = "toggle", display = "Show Global Cooldown", default = false },
cooldownRemainingArg(),
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
{ name = "onCooldown", type = "hidden", store = true, conditionType = "bool", display = "On Cooldown" },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = "Spell Name" },
{ name = "icon", type = "hidden", store = true },
{ name = "spellUsable", type = "hidden", store = true, conditionType = "bool", display = "Usable" },
{ name = "insufficientResources", type = "hidden", store = true, conditionType = "bool", display = "Insufficient Resources" },
{ name = "spellInRange", type = "hidden", store = true, conditionType = "bool", display = "In Range" },
},
}
-- Item cooldown, timed progress. Near-clone of spellcooldown, fed by a parallel
-- watcher keyed by itemID instead of spellID. GetItemCooldown returns
-- (start, duration, enable) directly rather than a table -- its pollRaw wrapper
-- (below, in the watcher section) reads them behind an if-guard, not an
-- `and`-chain, since `and`-chaining a multi-return call truncates it to one
-- value on this client's Lua 5.0 (confirmed; the existing
-- spellUsable/insufficientResources init above already avoids the same trap the
-- same way).
PROTOTYPES["itemcooldown"] = {
displayName = "Cooldown Progress (Item)",
wa2Event = "Cooldown Progress (Item)",
category = "item",
progressType = "timed",
events = function() return { "ITEM_COOLDOWN_CHANGED", "ITEM_COOLDOWN_READY" } end,
force_events = true,
loadFunc = function(trigger)
local id = WA.ResolveItemID(trigger.itemName)
if id then WA.WatchItemCooldown(id, trigger.use_remaining and (trigger.genericShowOn or "showOnCooldown") ~= "showOnReady") end
end,
icon = "Interface\\Icons\\INV_Misc_Bag_08",
iconFunc = function(trigger)
local _, ic = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return ic or "Interface\\Icons\\INV_Misc_Bag_08"
end,
nameFunc = function(trigger)
local name = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return name or (trigger.itemName and trigger.itemName ~= "" and trigger.itemName) or "?"
end,
init = function(trigger)
return "local itemId = " .. fmt(WA.ResolveItemID(trigger.itemName) or 0) .. "\n"
.. "local startTime, duration = WeakestAuras.ItemCdInfo(itemId)\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0\n"
.. "local onCooldown = " .. onCooldownExpr() .. " and true or false"
end,
args = {
{ name = "itemName", type = "item", display = "Item" },
{ name = "genericShowOn", type = "select", required = true, display = "Show",
valueList = { "showOnCooldown", "showOnReady", "showAlways" },
valueLabels = { showOnCooldown = "On Cooldown", showOnReady = "Ready", showAlways = "Always" },
default = "showOnCooldown", reloadOptions = true,
test = function(trigger)
local onCd = onCooldownExpr()
local mode = trigger.genericShowOn or "showOnCooldown"
if mode == "showOnReady" then return "not " .. onCd
elseif mode == "showAlways" then return "true"
else return onCd end
end },
cooldownRemainingArg(),
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
{ name = "onCooldown", type = "hidden", store = true, conditionType = "bool", display = "On Cooldown" },
},
}
-- Equipment-slot cooldown IDs, resolved once at load. GetInventorySlotInfo is
-- a native 1.12 global (not a ClassicAPI backport) -- safe to call at file
-- scope, same load-time-global pattern as the CLASSIC_API_VERSION gate
-- (WeakestAuras.lua). Covers the on-use slots that commonly carry an item
-- cooldown (trinkets, weapons); not an exhaustive slot list.
local EQUIP_SLOT_DEFS = {
{ key = "Trinket0Slot", label = "Trinket 1" },
{ key = "Trinket1Slot", label = "Trinket 2" },
{ key = "MainHandSlot", label = "Main Hand" },
{ key = "SecondaryHandSlot", label = "Off Hand" },
{ key = "NeckSlot", label = "Neck" },
{ key = "WaistSlot", label = "Waist" },
}
local EQUIP_SLOT_IDS, EQUIP_SLOT_LABELS = {}, {}
for i = 1, table.getn(EQUIP_SLOT_DEFS) do
local def = EQUIP_SLOT_DEFS[i]
local slotId = GetInventorySlotInfo and GetInventorySlotInfo(def.key)
if slotId then
table.insert(EQUIP_SLOT_IDS, slotId)
EQUIP_SLOT_LABELS[slotId] = def.label
end
end
PROTOTYPES["equipslotcooldown"] = {
displayName = "Cooldown Progress (Equipment Slot)",
wa2Event = "Cooldown Progress (Equipment Slot)",
category = "item",
progressType = "timed",
events = function() return { "EQUIPSLOT_COOLDOWN_CHANGED", "EQUIPSLOT_COOLDOWN_READY" } end,
force_events = true,
loadFunc = function(trigger)
if trigger.itemSlot then WA.WatchEquipSlotCooldown(trigger.itemSlot, trigger.use_remaining and (trigger.genericShowOn or "showOnCooldown") ~= "showOnReady") end
end,
migrate = function(trigger) renameArg(trigger, "equipSlot", "itemSlot") end,
icon = "Interface\\Icons\\INV_Misc_Bag_09",
iconFunc = function(trigger)
local slot = trigger.itemSlot
local link = slot and GetInventoryItemLink and GetInventoryItemLink("player", slot)
local _, ic = itemNameIcon(link)
return ic or "Interface\\Icons\\INV_Misc_Bag_09"
end,
nameFunc = function(trigger)
return EQUIP_SLOT_LABELS[trigger.itemSlot] or "?"
end,
init = function(trigger)
return "local itemSlot = " .. fmt(trigger.itemSlot or 0) .. "\n"
.. "local startTime, duration = WeakestAuras.EquipSlotCdInfo(itemSlot)\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0\n"
.. "local onCooldown = " .. onCooldownExpr() .. " and true or false"
end,
args = {
{ name = "itemSlot", type = "select", required = true, display = "Slot",
valueList = EQUIP_SLOT_IDS, valueLabels = EQUIP_SLOT_LABELS,
default = EQUIP_SLOT_IDS[1] },
{ name = "genericShowOn", type = "select", required = true, display = "Show",
valueList = { "showOnCooldown", "showOnReady", "showAlways" },
valueLabels = { showOnCooldown = "On Cooldown", showOnReady = "Ready", showAlways = "Always" },
default = "showOnCooldown", reloadOptions = true,
test = function(trigger)
local onCd = onCooldownExpr()
local mode = trigger.genericShowOn or "showOnCooldown"
if mode == "showOnReady" then return "not " .. onCd
elseif mode == "showAlways" then return "true"
else return onCd end
end },
cooldownRemainingArg(),
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
{ name = "onCooldown", type = "hidden", store = true, conditionType = "bool", display = "On Cooldown" },
},
}
-- The watcher's own edges only. It already reads the client's cooldown events
-- and emits GCD_UPDATE/GCD_END on the transitions that mean something, so
-- listening to the raw events here as well would re-evaluate on every unrelated
-- actionbar cooldown change and learn nothing.
PROTOTYPES["globalcooldown"] = {
displayName = "Global Cooldown",
wa2Event = "Global Cooldown",
category = "spell",
progressType = "timed",
events = function() return { "GCD_UPDATE", "GCD_END", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
loadFunc = function() WA.WatchGCD() end,
icon = "Interface\\Icons\\Spell_Holy_SealOfMight",
iconFunc = function() return "Interface\\Icons\\Spell_Holy_SealOfMight" end,
nameFunc = function() return "Global Cooldown" end,
init = function(trigger)
return "local startTime, duration = WeakestAuras.GcdInfo()\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0\n"
.. "local active = duration ~= nil and duration > 0 and expirationTime > GetTime()"
end,
args = {
{ name = "inverse", type = "toggle", display = "Inverse" },
{ name = "active", type = "hidden", required = true, store = true,
conditionType = "bool", display = "On Global Cooldown",
test = function(trigger) return trigger.inverse and "not active" or "active" end },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
{ name = "remaining", type = "hidden", store = true, conditionType = "number", display = "Time Remaining" },
},
}
-- "Ready" is the absence of a cooldown of the thing's own: an expired window, no
-- window, or a window that is only the global cooldown passing over it.
local function cooldownReadyInit(infoFunc, keySource, knownSource)
return "local cooldownKey = " .. keySource .. "\n"
.. "local startTime, duration = " .. infoFunc .. "(cooldownKey)\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local ready = (" .. knownSource .. ") and (duration == nil or WeakestAuras.IsGcdCooldown(duration) or duration <= 0 or expirationTime <= GetTime())"
end
-- Whether an item is the on-use kind a cooldown can belong to at all. Gear with
-- a passive or on-proc effect has no cooldown to be ready from, so a trigger
-- pointed at one should stay dark rather than claim to be permanently ready.
-- C_Item.GetItemSpell answers nil for an item not yet in the local cache and
-- requests it in the background, which is why the prototypes reading this also
-- listen for GET_ITEM_INFO_RECEIVED -- without that a cold-cached item would
-- read as passive until something else happened to re-evaluate the trigger.
local function itemHasUseSpell(itemId)
if not itemId or itemId == 0 then return false end
if C_Item and C_Item.GetItemSpell then
local spellName, spellId = C_Item.GetItemSpell(itemId)
return (spellId and spellId > 0) or (spellName and spellName ~= "")
end
if GetItemSpell then
local spellName = GetItemSpell(itemId)
return spellName and spellName ~= ""
end
return false
end
WA.ItemHasUseSpell = itemHasUseSpell
local function cooldownReadyArgs(kind, selector)
local args = {
{ name = "ready", type = "hidden", required = true, store = true,
conditionType = "bool", display = "Ready", test = "ready" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Ready Since" },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = kind .. " Name" },
{ name = "icon", type = "hidden", store = true },
}
table.insert(args, 1, selector)
return args
end
PROTOTYPES["spellcooldownready"] = {
displayName = "Cooldown Ready (Spell)",
wa2Event = "Cooldown Ready (Spell)",
category = "spell",
progressType = "timed",
events = function() return { "SPELL_COOLDOWN_CHANGED", "SPELL_COOLDOWN_READY", "SPELL_UPDATE_COOLDOWN" } end,
force_events = true,
loadFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if id then WA.WatchSpellCooldown(id) end
end,
icon = "Interface\\Icons\\Spell_Holy_BorrowedTime",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return "Interface\\Icons\\Spell_Holy_BorrowedTime" end
local _, _, icon = GetSpellInfo(id)
return icon or "Interface\\Icons\\Spell_Holy_BorrowedTime"
end,
nameFunc = function(trigger) return trigger.spellName or "Cooldown Ready" end,
init = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName) or 0
return cooldownReadyInit("WeakestAuras.SpellCdInfo", fmt(id),
"cooldownKey ~= 0 and WeakestAuras.SpellCdKnown(cooldownKey)")
.. "\nlocal name, _, icon = GetSpellInfo(cooldownKey)"
end,
args = cooldownReadyArgs("Spell", { name = "spellName", type = "spell", required = true, display = "Spell" }),
}
PROTOTYPES["itemcooldownready"] = {
displayName = "Cooldown Ready (Item)",
wa2Event = "Cooldown Ready (Item)",
category = "item",
progressType = "timed",
events = function() return { "ITEM_COOLDOWN_CHANGED", "ITEM_COOLDOWN_READY", "BAG_UPDATE_COOLDOWN", "GET_ITEM_INFO_RECEIVED" } end,
force_events = true,
loadFunc = function(trigger)
local id = WA.ResolveItemID(trigger.itemName)
if id then WA.WatchItemCooldown(id) end
end,
icon = "Interface\\Icons\\INV_Misc_Bag_08",
iconFunc = function(trigger)
local _, icon = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return icon or "Interface\\Icons\\INV_Misc_Bag_08"
end,
nameFunc = function(trigger)
local name = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return name or trigger.itemName or "Cooldown Ready"
end,
init = function(trigger)
local id = WA.ResolveItemID(trigger.itemName) or 0
return cooldownReadyInit("WeakestAuras.ItemCdInfo", fmt(id), "cooldownKey ~= 0 and WeakestAuras.ItemHasUseSpell(cooldownKey)")
.. "\nlocal name, _, _, _, _, _, _, _, _, icon = C_Item.GetItemInfo(cooldownKey)"
end,
args = cooldownReadyArgs("Item", { name = "itemName", type = "item", required = true, display = "Item" }),
}
PROTOTYPES["equipslotcooldownready"] = {
displayName = "Cooldown Ready (Equipment Slot)",
wa2Event = "Cooldown Ready (Equipment Slot)",
category = "item",
progressType = "timed",
events = function() return { "EQUIPSLOT_COOLDOWN_CHANGED", "EQUIPSLOT_COOLDOWN_READY", "BAG_UPDATE_COOLDOWN", "PLAYER_EQUIPMENT_CHANGED", "GET_ITEM_INFO_RECEIVED" } end,
force_events = true,
loadFunc = function(trigger)
if trigger.itemSlot then WA.WatchEquipSlotCooldown(trigger.itemSlot) end
end,
migrate = function(trigger) renameArg(trigger, "equipSlot", "itemSlot") end,
icon = "Interface\\Icons\\INV_Misc_Bag_09",
iconFunc = function(trigger)
local slot = trigger.itemSlot
local link = slot and GetInventoryItemLink and GetInventoryItemLink("player", slot)
local _, icon = itemNameIcon(link)
return icon or "Interface\\Icons\\INV_Misc_Bag_09"
end,
nameFunc = function(trigger) return EQUIP_SLOT_LABELS[trigger.itemSlot] or "Cooldown Ready" end,
init = function(trigger)
return "local cooldownKey = " .. fmt(trigger.itemSlot or 0) .. "\n"
.. "local startTime, duration = WeakestAuras.EquipSlotCdInfo(cooldownKey)\n"
.. "local expirationTime = (startTime and duration and (startTime + duration)) or 0\n"
.. "local itemSlot = cooldownKey\n"
.. "local item = GetInventoryItemID and GetInventoryItemID(\"player\", cooldownKey)\n"
.. "local hasUseSpell = WeakestAuras.ItemHasUseSpell(item)\n"
.. "local ready = (cooldownKey ~= 0 and hasUseSpell) and (duration == nil or WeakestAuras.IsGcdCooldown(duration) or duration <= 0 or expirationTime <= GetTime())\n"
.. "local name, _, _, _, _, _, _, _, _, icon = item and C_Item.GetItemInfo(item) or nil"
end,
args = cooldownReadyArgs("Equipment", {
name = "itemSlot", type = "select", required = true, display = "Equipment Slot",
valueList = EQUIP_SLOT_IDS, valueLabels = EQUIP_SLOT_LABELS, default = EQUIP_SLOT_IDS[1],
}),
}
PROTOTYPES["actionusable"] = {
displayName = "Action Usable",
wa2Event = "Action Usable",
category = "spell",
progressType = "none",
events = function() return { "SPELL_UPDATE_USABLE", "SPELL_COOLDOWN_CHANGED", "PLAYER_TARGET_CHANGED" } end,
force_events = true,
loadFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if id then WA.WatchSpellCooldown(id) end
end,
icon = "Interface\\Icons\\Spell_Holy_BorrowedTime",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return "Interface\\Icons\\Spell_Holy_BorrowedTime" end
local _, _, icon = GetSpellInfo(id)
return icon or "Interface\\Icons\\Spell_Holy_BorrowedTime"
end,
nameFunc = function(trigger) return trigger.spellName or "Action Usable" end,
init = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName) or 0
return "local spellId = " .. fmt(id) .. "\n"
.. "local usable, insufficientResources = false, false\n"
.. "if IsUsableSpell then local _u, _m = IsUsableSpell(spellId) usable = _u and true or false insufficientResources = _m and true or false end\n"
.. "local startTime, duration = WeakestAuras.SpellCdInfo(spellId)\n"
.. "local ready = (duration == nil or WeakestAuras.IsGcdCooldown(duration) or duration <= 0 or not startTime or startTime == 0 or (startTime + duration) <= GetTime())\n"
.. "local active = usable and ready\n"
.. "local spellInRange = WeakestAuras.SpellInRange(spellId)"
end,
args = {
{ name = "spellName", type = "spell", display = "Spell", required = true },
{ name = "targetRequired", type = "toggle", display = "Require Valid Target", reloadOptions = true },
{ name = "ignoreSpellCooldown", type = "toggle", display = "Ignore Spell Cooldown", reloadOptions = true },
{ name = "inverse", type = "toggle", display = "Inverse", reloadOptions = true },
{ name = "active", type = "hidden", required = true, store = true, conditionType = "bool",
display = "Usable", test = function(trigger)
local test = trigger.ignoreSpellCooldown and "usable" or "active"
if trigger.targetRequired then test = test .. " and spellInRange" end
if trigger.inverse then return "not (" .. test .. ")" end
return test
end },
{ name = "usable", type = "hidden", store = true, conditionType = "bool", display = "Spell Usable" },
{ name = "insufficientResources", type = "hidden", store = true, conditionType = "bool", display = "Insufficient Resources" },
{ name = "spellInRange", type = "hidden", store = true, conditionType = "bool", display = "In Range" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Cooldown Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Cooldown End" },
},
}
-- Cast/channel progress (player/target), polled -- ClassicAPI's C_Spell.
-- Unit/ChannelInfo only cover a unit's own cast reliably by polling; this client
-- has no combat log to track an arbitrary caster from. SuperWoW's UNIT_CASTEVENT
-- would extend this to any GUID with real payload -- a separate extension point.
-- Both C_Spell calls return several values positionally; captured through
-- named throwaway locals first and reassigned, rather than destructured
-- directly into the final names, so the two different return shapes
-- (UnitCastingInfo has castID at position 7, UnitChannelInfo doesn't) can't
-- be confused with each other.
PROTOTYPES["cast"] = {
displayName = "Cast",
wa2Event = "Cast",
category = "unit",
progressType = "timed",
-- Vanilla's arg-less SPELLCAST_* only reports the player's own casts; the
-- ClassicAPI UNIT_SPELLCAST_* layer carries arg1 = the casting unit and is
-- what makes any unit but the player -- and every member of a multi-unit
-- family -- report a cast at all. Only the six all-unit events are listed:
-- DELAYED/FAILED/CHANNEL_UPDATE are player-only there and already covered.
events = function(trigger)
return appendMultiUnitEvents(trigger, { "SPELLCAST_START", "SPELLCAST_STOP",
"SPELLCAST_CHANNEL_START", "SPELLCAST_CHANNEL_STOP", "SPELLCAST_FAILED",
"SPELLCAST_INTERRUPTED", "PLAYER_TARGET_CHANGED",
"UNIT_SPELLCAST_START", "UNIT_SPELLCAST_STOP", "UNIT_SPELLCAST_SUCCEEDED",
"UNIT_SPELLCAST_INTERRUPTED", "UNIT_SPELLCAST_CHANNEL_START",
"UNIT_SPELLCAST_CHANNEL_STOP" })
end,
force_events = true,
statesParameter = "unit",
icon = "Interface\\Icons\\Spell_Nature_WispSplode",
iconFunc = function() return "Interface\\Icons\\Spell_Nature_WispSplode" end,
nameFunc = function(trigger) return "Cast (" .. (multiUnitFamily(trigger) or WA.TriggerUnit(trigger, "player")) .. ")" end,
init = function(trigger)
return multiUnitInit(trigger, "player") .. "\n"
.. "local castName, castIcon, startMs, endMs, notInterruptible, castingSpellID\n"
.. "if C_Spell and C_Spell.UnitCastingInfo then\n"
.. "\tlocal _n, _d, _i, _s, _e, _t, _c, _ni, _sid = C_Spell.UnitCastingInfo(unit)\n"
.. "\tcastName, castIcon, startMs, endMs, notInterruptible, castingSpellID = _n, _i, _s, _e, _ni, _sid\n"
.. "end\n"
.. "local chanName, chanIcon, chanStartMs, chanEndMs, chanNotInterruptible, chanSpellID\n"
.. "if not castName and C_Spell and C_Spell.UnitChannelInfo then\n"
.. "\tlocal _n2, _d2, _i2, _s2, _e2, _t2, _ni2, _sid2 = C_Spell.UnitChannelInfo(unit)\n"
.. "\tchanName, chanIcon, chanStartMs, chanEndMs, chanNotInterruptible, chanSpellID = _n2, _i2, _s2, _e2, _ni2, _sid2\n"
.. "end\n"
.. "local casting = castName ~= nil\n"
.. "local channeling = chanName ~= nil\n"
.. "local active = casting or channeling\n"
.. "local name = castName or chanName\n"
.. "local icon = castIcon or chanIcon\n"
.. "local spellId = castingSpellID or chanSpellID\n"
.. "local notInterruptibleFlag = (casting and notInterruptible) or (channeling and chanNotInterruptible) or false\n"
.. "local startTime = ((casting and startMs) or (channeling and chanStartMs) or 0) / 1000\n"
.. "local expirationTime = ((casting and endMs) or (channeling and chanEndMs) or 0) / 1000\n"
.. "local duration = (expirationTime > 0 and startTime > 0) and (expirationTime - startTime) or 0"
end,
args = {
{ name = "unit", type = "unit", display = "Unit",
valueList = WA.unit_tokens_multi, valueLabels = WA.unit_labels_multi,
store = true, conditionType = "string" },
{ name = "unitName", type = "hidden", init = "UnitName(unit)",
store = true, conditionType = "string", display = "Unit Name" },
{ name = "active", type = "hidden", required = true, test = "active" },
{ name = "casting", type = "hidden", store = true, conditionType = "bool", display = "Casting" },
{ name = "channeling", type = "hidden", store = true, conditionType = "bool", display = "Channeling" },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = "Spell Name" },
{ name = "icon", type = "hidden", store = true },
{ name = "spellId", type = "hidden", store = true, conditionType = "number", display = "Spell ID" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Cast End" },
{ name = "notInterruptibleFlag", type = "hidden", store = true, conditionType = "bool", display = "Not Interruptible" },
},
}
-- A completed cast is an instant, not a state, so this prototype shows for a
-- configured window and takes itself back down (autoHide) rather than waiting
-- for an event that says the cast stopped being true.
--
-- Nampower's SPELL_GO_SELF is the signal, through the shared dispatch above.
-- SuperWoW's UNIT_CASTEVENT also reports completed casts and covers *every*
-- unit, but it fires a CAST for spells the player never chose -- procs and
-- companion ids land alongside the real one -- whereas SPELL_GO_SELF is exactly
-- the player's own cast. Hence: your casts only, and no unit arg.
PROTOTYPES["castsucceeded"] = {
displayName = "Spell Cast Succeeded",
wa2Event = "Spell Cast Succeeded",
category = "spell",
autoHide = true,
enable = function() return WA.hasNampower end,
events = function() return { "WA_SPELL_CAST_SUCCEEDED" } end,
loadFunc = function() WA.WatchSpellCast() end,
icon = "Interface\\Icons\\Spell_Holy_MagicalSentry",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return "Interface\\Icons\\Spell_Holy_MagicalSentry" end
local _, _, ic = GetSpellInfo(id)
return ic or "Interface\\Icons\\Spell_Holy_MagicalSentry"
end,
nameFunc = function(trigger)
return (trigger.spellName and trigger.spellName ~= "" and trigger.spellName) or "Cast Succeeded"
end,
init = function(trigger)
return "local castSpellId = arg1\n"
.. "local wantSpellId = " .. fmt(WA.ResolveSpellID(trigger.spellName) or 0) .. "\n"
end,
args = {
{ name = "spellName", type = "spell", display = "Spell" },
-- An unset or unresolvable spell name resolves to 0, which must match
-- nothing rather than fire on every cast the player makes.
{ name = "matched", type = "hidden", required = true,
test = "wantSpellId ~= 0 and castSpellId == wantSpellId" },
{ name = "duration", type = "range", display = "Show For (s)",
min = 0.5, max = 10, step = 0.5, default = 1 },
{ name = "castSpellId", type = "hidden", store = true,
conditionType = "number", display = "Spell ID" },
},
}
PROTOTYPES["readycheck"] = {
displayName = "Ready Check",
wa2Event = "Ready Check",
category = "event",
eventMode = true,
autoHide = true,
events = function() return { "READY_CHECK" } end,
icon = "Interface\\Icons\\Spell_Holy_DivineIllumination",
iconFunc = function() return "Interface\\Icons\\Spell_Holy_DivineIllumination" end,
args = {
{ name = "duration", type = "range", display = "Show For (s)",
min = 0.5, max = 10, step = 0.5, default = 1 },
},
}
PROTOTYPES["combatevents"] = {
displayName = "Combat Events",
category = "event",
eventMode = true,
autoHide = true,
events = function() return COMBAT_EVENT_VALUES end,
icon = "Interface\\Icons\\Ability_Warrior_Charge",
iconFunc = function() return "Interface\\Icons\\Ability_Warrior_Charge" end,
args = {
{ name = "eventtype", type = "select", display = "Type", required = true,
valueList = COMBAT_EVENT_VALUES, valueLabels = COMBAT_EVENT_LABELS,
default = "PLAYER_REGEN_DISABLED", store = true, conditionType = "string",
init = "event",
test = function(trigger) return "event == " .. fmt(trigger.eventtype or "") end },
{ name = "duration", type = "range", display = "Show For (s)",
min = 0.5, max = 10, step = 0.5, default = 1 },
},
}
PROTOTYPES["chatmessage"] = {
displayName = "Chat Message",
wa2Event = "Chat Message",
category = "event",
eventMode = true,
autoHide = true,
events = chatMessageEvents,
icon = "Interface\\Icons\\INV_Misc_Note_01",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Note_01" end,
init = function(trigger)
local base = trigger and trigger.messageType
return "if event == 'CHAT_MSG_PARTY_LEADER' then event = 'CHAT_MSG_PARTY' elseif event == 'CHAT_MSG_RAID_LEADER' then event = 'CHAT_MSG_RAID' elseif event == 'CHAT_MSG_TEXT_EMOTE' then event = 'CHAT_MSG_EMOTE' end"
end,
args = {
{ name = "messageType", type = "select", display = "Message Type", init = "event",
valueList = CHAT_MESSAGE_VALUES, valueLabels = CHAT_MESSAGE_LABELS,
default = "CHAT_MSG_SAY" },
{ name = "message", type = "string", display = "Message", init = "arg1",
store = true, conditionType = "string" },
{ name = "sourceName", type = "string", display = "Source Name", init = "arg2",
store = true, conditionType = "string" },
{ name = "destName", type = "string", display = "Destination Name", init = "arg5",
store = true, conditionType = "string" },
{ name = "use_cloneId", type = "toggle", display = "Clone per Event", default = false },
{ name = "duration", type = "range", display = "Show For (s)",
min = 0.5, max = 10, step = 0.5, default = 1 },
},
}
-- Status bool: has the player learned this spell. IsSpellKnown is a native
-- global taking a numeric spellID (3.3.5 semantics).
PROTOTYPES["spellknown"] = {
displayName = "Spell Known",
wa2Event = "Spell Known",
category = "spell",
progressType = "none",
events = function() return { "SPELLS_CHANGED", "LEARNED_SPELL_IN_TAB" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Book_09",
iconFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return "Interface\\Icons\\INV_Misc_Book_09" end
local _, _, ic = GetSpellInfo(id)
return ic or "Interface\\Icons\\INV_Misc_Book_09"
end,
nameFunc = function(trigger)
local id = WA.ResolveSpellID(trigger.spellName)
if not id then return (trigger.spellName and trigger.spellName ~= "") and trigger.spellName or "?" end
return GetSpellInfo(id) or trigger.spellName or "?"
end,
init = function(trigger)
return "local spellId = " .. fmt(WA.ResolveSpellID(trigger.spellName) or 0) .. "\n"
.. "local known = (IsSpellKnown and IsSpellKnown(spellId)) and true or false"
end,
args = {
{ name = "spellName", type = "spell", display = "Spell" },
{ name = "known", type = "hidden", required = true, test = "known", store = true, conditionType = "bool", display = "Known" },
},
}
-- Status: current shapeshift/stance form. Vanilla SpellShapeshiftForm.dbc IDs
-- don't match modern WoW's numbering and vary per class -- exposed as a raw
-- number (0 = no form) rather than a hardcoded per-class select, so this
-- doesn't ship a wrong ID table; a user determines their own class's IDs
-- in-game and filters on them directly.
PROTOTYPES["stance"] = {
displayName = "Stance/Form",
wa2Event = "Stance/Form/Aura",
category = "unit",
progressType = "none",
events = function() return { "UPDATE_SHAPESHIFT_FORM" } end,
force_events = true,
icon = "Interface\\Icons\\Ability_Druid_CatForm",
iconFunc = function() return "Interface\\Icons\\Ability_Druid_CatForm" end,
nameFunc = function() return "Stance/Form" end,
init = function()
return "local formId = (GetShapeshiftFormID and GetShapeshiftFormID()) or 0\n"
.. "local inForm = formId ~= 0"
end,
args = {
{ name = "formId", type = "number", display = "Form ID", operator = "==",
store = true, conditionType = "number" },
{ name = "inForm", type = "hidden", store = true, conditionType = "bool", display = "In Any Form" },
},
}
-- Status number: bag+bank item count. C_Item.GetItemCount returns a single
-- value (no multi-return truncation risk from the `and`-chain below).
PROTOTYPES["itemcount"] = {
displayName = "Item Count",
wa2Event = "Item Count",
category = "item",
progressType = "none",
events = function() return { "BAG_UPDATE", "BANKFRAME_OPENED", "BANKFRAME_CLOSED" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Bag_10",
iconFunc = function(trigger)
local _, ic = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return ic or "Interface\\Icons\\INV_Misc_Bag_10"
end,
nameFunc = function(trigger)
local name = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return name or (trigger.itemName and trigger.itemName ~= "" and trigger.itemName) or "?"
end,
init = function(trigger)
return "local count, itemKnown = WeakestAuras.ItemCount("
.. fmt(trigger.itemName or "") .. ", "
.. fmt(trigger.includeBank and true or false) .. ")"
end,
args = {
{ name = "itemName", type = "item", display = "Item" },
-- No gate on the item resolving. A name that matches nothing the player
-- holds is indistinguishable from holding none of it, and "warn me when
-- I'm out" is the main reason to want this trigger -- so an unresolved
-- item counts 0 and shows, rather than compiling a display that can
-- never appear.
{ name = "includeBank", type = "toggle", display = "Include Bank" },
{ name = "count", type = "number", display = "Count", operator = ">=", store = true, conditionType = "number" },
{ name = "itemKnown", type = "hidden", store = true, conditionType = "bool", display = "Item Identified" },
},
}
-- Status bool: is this item currently equipped (any slot). C_Item.
-- IsEquippedItem accepts an itemID/link/name directly (same shapes as
-- GetItemInfo), so the raw config string is passed through rather than
-- resolved to an ID first.
PROTOTYPES["itemequipped"] = {
displayName = "Item Equipped",
wa2Event = "Item Equipped",
category = "item",
progressType = "none",
events = function() return { "UNIT_INVENTORY_CHANGED", "PLAYER_EQUIPMENT_CHANGED" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Chest_Cloth_17",
iconFunc = function(trigger)
local _, ic = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return ic or "Interface\\Icons\\INV_Chest_Cloth_17"
end,
nameFunc = function(trigger)
local name = itemNameIcon(WA.ResolveItemID(trigger.itemName))
return name or (trigger.itemName and trigger.itemName ~= "" and trigger.itemName) or "?"
end,
init = function(trigger)
return "local itemRef = " .. fmt(trigger.itemName or "") .. "\n"
.. "local equipped = (C_Item and C_Item.IsEquippedItem and itemRef ~= \"\" and C_Item.IsEquippedItem(itemRef)) and true or false"
end,
args = {
{ name = "itemName", type = "item", display = "Item" },
{ name = "equipped", type = "hidden", required = true, test = "equipped", store = true, conditionType = "bool", display = "Equipped" },
},
}
local ITEM_EQUIP_SLOTS = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 }
local ITEM_EQUIP_SLOT_LABELS = {
[0] = "Any Slot", [1] = "Head", [2] = "Neck", [3] = "Shoulder", [4] = "Shirt",
[5] = "Chest", [6] = "Waist", [7] = "Legs", [8] = "Feet", [9] = "Wrist",
[10] = "Hands", [11] = "Finger 1", [12] = "Finger 2", [13] = "Trinket 1",
[14] = "Trinket 2", [15] = "Back", [16] = "Main Hand", [17] = "Off Hand",
[18] = "Ranged", [19] = "Tabard",
}
local ITEM_CLASS_IDS, ITEM_CLASS_LABELS = {}, {}
local ITEM_SUBCLASS_IDS, ITEM_SUBCLASS_LABELS = {}, {}
local fallbackItemClasses = {
[0] = "Consumable", [1] = "Container", [2] = "Weapon", [3] = "Gem",
[4] = "Armor", [5] = "Reagent", [6] = "Projectile", [7] = "Trade Goods",
[8] = "Item Enhancement", [9] = "Recipe", [10] = "Currency",
[11] = "Quiver", [12] = "Quest", [13] = "Key", [14] = "Permanent",
[15] = "Miscellaneous",
}
for classID = 0, 15 do
local label = C_Item and C_Item.GetItemClassInfo and C_Item.GetItemClassInfo(classID)
if not label or label == "" then label = fallbackItemClasses[classID] end
if label then
table.insert(ITEM_CLASS_IDS, classID)
ITEM_CLASS_LABELS[classID] = label
ITEM_SUBCLASS_IDS[classID] = {}
ITEM_SUBCLASS_LABELS[classID] = {}
for subclassID = 0, 31 do
local subclass = C_Item and C_Item.GetItemSubClassInfo and
C_Item.GetItemSubClassInfo(classID, subclassID)
if subclass and subclass ~= "" then
table.insert(ITEM_SUBCLASS_IDS[classID], subclassID)
ITEM_SUBCLASS_LABELS[classID][subclassID] = subclass
end
end
end
end
local function itemSubclassValues(classID)
local ids = ITEM_SUBCLASS_IDS[tonumber(classID) or -1]
local labels = ITEM_SUBCLASS_LABELS[tonumber(classID) or -1]
if ids and table.getn(ids) > 0 then return ids, labels end
return { 0 }, { [0] = "Unknown" }
end
PROTOTYPES["itemtypeequipped"] = {
displayName = "Item Type Equipped",
wa2Event = "Item Type Equipped",
category = "item",
progressType = "none",
events = function() return { "PLAYER_EQUIPMENT_CHANGED", "UNIT_INVENTORY_CHANGED", "WA_DELAYED_PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Bag_10",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Bag_10" end,
nameFunc = function() return "Item Type Equipped" end,
migrate = function(trigger)
if trigger.itemClassID ~= nil then trigger.itemClassID = tonumber(trigger.itemClassID) or trigger.itemClassID end
if trigger.itemSubclassID ~= nil then trigger.itemSubclassID = tonumber(trigger.itemSubclassID) or trigger.itemSubclassID end
end,
init = function(trigger)
return "local wantedClassID = tonumber(" .. fmt(trigger.itemClassID or "") .. ") or -1\n"
.. "local wantedSubclassID = tonumber(" .. fmt(trigger.itemSubclassID or "") .. ") or -1\n"
.. "local selectedSlot = " .. fmt(tonumber(trigger.itemSlot) or 0) .. "\n"
.. "local inverse = " .. fmt(trigger.inverse and true or false) .. "\n"
.. "local itemIDValue, itemNameValue, itemIconValue, itemClassValue, itemSubclassValue, itemClassIDValue, itemSubclassIDValue, equippedValue, matchingValue, itemKnownValue = WeakestAuras.ItemTypeEquipped(wantedClassID, wantedSubclassID, selectedSlot)"
end,
args = {
{ name = "itemClassID", type = "select", display = "Item Class", required = true,
valueList = ITEM_CLASS_IDS, valueLabels = ITEM_CLASS_LABELS, default = 2,
test = function() return nil end, reloadOptions = true },
{ name = "itemSubclassID", type = "select", display = "Item Subclass", required = true,
valueList = function(trigger) return itemSubclassValues(trigger.itemClassID) end,
valueLabels = function(trigger) return ITEM_SUBCLASS_LABELS[tonumber(trigger.itemClassID) or -1] end,
default = 0, test = function() return nil end },
{ name = "itemSlot", type = "select", required = true, init = "selectedSlot", display = "Equipment Slot",
valueList = ITEM_EQUIP_SLOTS, valueLabels = ITEM_EQUIP_SLOT_LABELS, default = 0 },
{ name = "inverse", type = "toggle", display = "Inverse" },
{ name = "itemID", type = "hidden", init = "itemIDValue", store = true, storeAlways = true, conditionType = "number", display = "Item ID" },
{ name = "itemName", type = "hidden", init = "itemNameValue", store = true, storeAlways = true, conditionType = "string", display = "Item Name" },
{ name = "name", type = "hidden", init = "itemNameValue", store = true, storeAlways = true, conditionType = "string", display = "Name" },
{ name = "icon", type = "hidden", init = "itemIconValue", store = true, storeAlways = true, display = "Icon" },
{ name = "itemClassName", type = "hidden", init = "itemClassValue", store = true, storeAlways = true, conditionType = "string", display = "Item Class" },
{ name = "itemSubclassName", type = "hidden", init = "itemSubclassValue", store = true, storeAlways = true, conditionType = "string", display = "Item Subclass" },
{ name = "foundClassID", type = "hidden", init = "itemClassIDValue", store = true, storeAlways = true, conditionType = "number", display = "Found Item Class ID" },
{ name = "foundSubclassID", type = "hidden", init = "itemSubclassIDValue", store = true, storeAlways = true, conditionType = "number", display = "Found Item Subclass ID" },
{ name = "equipped", type = "hidden", init = "equippedValue", store = true, storeAlways = true, conditionType = "bool", display = "Equipped" },
{ name = "matching", type = "hidden", required = true, init = "matchingValue", store = true, storeAlways = true, conditionType = "bool", display = "Matching Type",
test = function(trigger) return trigger.inverse and "not matching" or "matching" end },
{ name = "itemKnown", type = "hidden", init = "itemKnownValue", store = true, storeAlways = true, conditionType = "bool", display = "Item Metadata Available" },
},
}
PROTOTYPES["itemset"] = {
displayName = "Item Set Equipped",
wa2Event = "Item Set",
category = "item",
progressType = "static",
progressValue = "count",
progressTotal = "total",
events = function() return { "PLAYER_EQUIPMENT_CHANGED", "GET_ITEM_INFO_RECEIVED", "WA_DELAYED_PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Chest_Cloth_17",
iconFunc = function() return "Interface\\Icons\\INV_Chest_Cloth_17" end,
migrate = function(trigger) renameArg(trigger, "itemSetID", "itemSetId") end,
nameFunc = function(trigger)
local _, _, name = WA.ItemSetEquipped(trigger.itemSetId)
return name or "Item Set Equipped"
end,
init = function(trigger)
return "local countValue, totalValue, setNameValue, setKnownValue = WeakestAuras.ItemSetEquipped("
.. fmt(trigger.itemSetId or 0) .. ")"
end,
args = {
{ name = "itemSetId", type = "text", display = "Item Set ID", required = true, default = "0" },
{ name = "inverse", type = "toggle", display = "Inverse" },
{ name = "count", type = "hidden", init = "countValue", store = true, conditionType = "number", display = "Equipped Pieces" },
{ name = "total", type = "hidden", init = "totalValue", store = true, conditionType = "number", display = "Set Pieces" },
{ name = "setName", type = "hidden", init = "setNameValue", store = true, conditionType = "string", display = "Set Name" },
{ name = "setKnown", type = "hidden", init = "setKnownValue", store = true, conditionType = "bool", display = "Set Identified" },
{ name = "active", type = "hidden", required = true, test = function(trigger)
return trigger.inverse and "count == 0" or "count > 0"
end, store = true, init = "countValue > 0", conditionType = "bool", display = "Active" },
},
}
PROTOTYPES["equipmentset"] = {
displayName = "Equipment Set Equipped",
wa2Event = "Equipment Set",
category = "item",
progressType = "static",
progressValue = "count",
progressTotal = "total",
events = function() return { "PLAYER_EQUIPMENT_CHANGED", "WEAR_EQUIPMENT_SET", "EQUIPMENT_SETS_CHANGED", "EQUIPMENT_SWAP_FINISHED", "WA_DELAYED_PLAYER_ENTERING_WORLD" } end,
force_events = true,
migrate = function(trigger) renameArg(trigger, "equipmentSetName", "itemSetName") end,
icon = "Interface\\Icons\\INV_Misc_Gear_03",
iconFunc = function(trigger)
local _, icon = WA.EquipmentSetInfo(trigger.itemSetName, trigger.partial)
return icon or "Interface\\Icons\\INV_Misc_Gear_03"
end,
nameFunc = function(trigger)
local name = WA.EquipmentSetInfo(trigger.itemSetName, trigger.partial)
return name or "Equipment Set Equipped"
end,
init = function(trigger)
return "local setNameValue, setIconValue, countValue, totalValue, activeValue, setIDValue, ignoredValue = WeakestAuras.EquipmentSetInfo("
.. fmt(trigger.itemSetName or "") .. ", " .. fmt(trigger.partial and true or false) .. ")"
end,
args = {
{ name = "itemSetName", type = "text", display = "Equipment Set", required = true },
{ name = "partial", type = "toggle", display = "Allow Partial Matches" },
{ name = "inverse", type = "toggle", display = "Inverse" },
{ name = "name", type = "hidden", init = "setNameValue", store = true, conditionType = "string", display = "Set Name" },
{ name = "icon", type = "hidden", init = "setIconValue", store = true, display = "Icon" },
{ name = "count", type = "hidden", init = "countValue", store = true, conditionType = "number", display = "Equipped Pieces" },
{ name = "total", type = "hidden", init = "totalValue", store = true, conditionType = "number", display = "Set Pieces" },
{ name = "setID", type = "hidden", init = "setIDValue", store = true, conditionType = "number", display = "Set ID" },
{ name = "ignored", type = "hidden", init = "ignoredValue", store = true, conditionType = "number", display = "Ignored Slots" },
{ name = "active", type = "hidden", required = true, init = "activeValue", store = true, conditionType = "bool", display = "Active",
test = function(trigger) return trigger.inverse and "not active" or "active" end },
},
}
-- Status: static facts about a unit. UnitClassBase (ClassicAPI backport)
-- returns two values -- captured through pre-declared locals set inside an
-- if-block rather than an `and`-chain, for the same multi-return-truncation
-- reason documented above the itemcooldown prototype.
PROTOTYPES["unitcharacteristics"] = {
displayName = "Unit Characteristics",
wa2Event = "Unit Characteristics",
category = "unit",
progressType = "none",
events = function() return { "UNIT_LEVEL", "PLAYER_TARGET_CHANGED", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_QuestionMark",
iconFunc = function() return "Interface\\Icons\\INV_Misc_QuestionMark" end,
nameFunc = function(trigger)
local unit = WA.TriggerUnit(trigger, "target")
return UnitName(unit) or unit
end,
init = function(trigger)
return "local unit = " .. fmt(WA.TriggerUnit(trigger, "target")) .. "\n"
.. "local unitName = UnitName(unit)\n"
.. "local level = UnitLevel(unit) or 0\n"
.. "local classFile, classId\n"
.. "if UnitClassBase then classFile, classId = UnitClassBase(unit) end\n"
.. "local creatureType = UnitCreatureType(unit) or \"\"\n"
.. "local classification = UnitClassification(unit) or \"\"\n"
.. "local isPlayer = UnitIsPlayer(unit) and true or false"
end,
args = {
{ name = "unit", type = "unit", display = "Unit", default = "target" },
{ name = "exists", type = "hidden", required = true, test = "UnitExists(unit)" },
{ name = "unitName", type = "string", store = true, conditionType = "string", display = "Name" },
{ name = "level", type = "number", display = "Level", operator = ">=", store = true, conditionType = "number" },
{ name = "classFile", type = "hidden", store = true, conditionType = "string", display = "Class" },
{ name = "creatureType", type = "hidden", store = true, conditionType = "string", display = "Creature Type" },
{ name = "classification", type = "select", display = "Classification",
valueList = { "normal", "elite", "rareelite", "rare", "worldboss" },
store = true, conditionType = "string" },
{ name = "isPlayer", type = "hidden", store = true, conditionType = "bool", display = "Is Player" },
},
}
-- Custom status and event triggers use upstream's saved field names. Legacy
-- local status records keep their state-first call signature; upstream-shaped
-- functions receive event first.
PROTOTYPES["custom"] = {
displayName = "Custom",
category = "custom",
custom = true,
progressType = "none",
events = function(trigger) return parseEventList(trigger and trigger.events) end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Gear_08",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Gear_08" end,
nameFunc = function() return "Custom" end,
migrate = function(trigger)
if trigger.customTrigger ~= nil then
if trigger.custom == nil then
trigger.custom = trigger.customTrigger
trigger.weakestAurasLegacyStateArgs = true
end
trigger.customTrigger = nil
end
if trigger.customEvents ~= nil then
if trigger.events == nil then trigger.events = trigger.customEvents end
trigger.customEvents = nil
end
end,
defaults = {
custom_type = "status",
check = "event",
events = "",
custom = "function(event, ...)\n return true\nend",
custom_hide = "timed",
duration = 1,
customDuration = "",
customName = "",
customIcon = "",
},
args = {},
}
-- Combo points on the current target, static progress (n/5). Always active
-- (like Health/Power) -- the count IS the display; add a condition or filter for
-- "only at 5". GetComboPoints on this client answers for the player's points on
-- the target; passing ("player","target") matches ClassicAPI's 3.3.5 semantics
-- and is harmless if the native form ignores the extra arg.
PROTOTYPES["combopoints"] = {
displayName = "Combo Points",
category = "unit",
progressType = "static",
progressValue = "comboPoints",
progressTotal = "maxComboPoints",
events = function() return { "PLAYER_COMBO_POINTS", "PLAYER_TARGET_CHANGED" } end,
force_events = true,
icon = "Interface\\Icons\\Ability_Rogue_Eviscerate",
iconFunc = function() return "Interface\\Icons\\Ability_Rogue_Eviscerate" end,
nameFunc = function() return "Combo Points" end,
init = function()
return "local comboPoints = (GetComboPoints and GetComboPoints(\"player\", \"target\")) or 0\n"
.. "local maxComboPoints = 5"
end,
args = {
{ name = "comboPoints", type = "number", display = "Combo Points", operator = ">=",
store = true, conditionType = "number" },
{ name = "maxComboPoints", type = "hidden", store = true, conditionType = "number", display = "Max Combo Points" },
},
}
-- Temporary weapon enchant, timed progress. Oils/sharpening stones/shaman
-- imbues/rogue poisons. Fed by WA.WeaponEnchantInfo (which remembers the
-- original duration for a proper depleting bar) + WA_SLOW_TICK for the expiry
-- flip. name comes from the enchant record when resolvable.
PROTOTYPES["weaponenchant"] = {
displayName = "Weapon Enchant (Temporary)",
wa2Event = "Weapon Enchant",
category = "item",
progressType = "timed",
events = function() return { "UNIT_INVENTORY_CHANGED", "PLAYER_ENTERING_WORLD", "WA_SLOW_TICK" } end,
force_events = true,
loadFunc = function() WA.EnsureSlowTick() end,
icon = "Interface\\Icons\\INV_Potion_105",
iconFunc = function() return "Interface\\Icons\\INV_Potion_105" end,
migrate = function(trigger) renameArg(trigger, "hand", "weapon") end,
nameFunc = function(trigger)
local h = trigger.weapon or "main"
return (h == "off" and "Off Hand Enchant") or (h == "ranged" and "Ranged Enchant") or "Main Hand Enchant"
end,
init = function(trigger)
return "local weapon = " .. fmt(trigger.weapon or "main") .. "\n"
.. "local has, expirationTime, duration, enchantId = WeakestAuras.WeaponEnchantInfo(weapon)\n"
.. "local name = \"Weapon Enchant\"\n"
.. "if enchantId and C_Item and C_Item.GetEnchantInfo then local ei = C_Item.GetEnchantInfo(enchantId) if ei and ei.name then name = ei.name end end\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0"
end,
args = {
{ name = "weapon", type = "select", required = true, display = "Weapon",
valueList = { "main", "off", "ranged" },
valueLabels = { main = "Main Hand", off = "Off Hand", ranged = "Ranged" },
default = "main" },
{ name = "has", type = "hidden", required = true, test = "has" },
{ name = "remaining", type = "number", display = "Remaining Time", operator = "<=" },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = "Enchant Name" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
},
}
-- Reputation with a named faction, static progress within the current standing
-- bar. Niche; the user types the faction name exactly (WA.FactionStanding walks
-- the list for it). standingID 1..8 = Hated..Exalted.
PROTOTYPES["reputation"] = {
displayName = "Reputation",
wa2Event = "Faction Reputation",
category = "unit",
progressType = "static",
progressValue = "repValue",
progressTotal = "repMax",
events = function() return { "UPDATE_FACTION", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_BannerPVP_02",
iconFunc = function() return "Interface\\Icons\\INV_BannerPVP_02" end,
nameFunc = function(trigger)
return (trigger.factionName and trigger.factionName ~= "") and trigger.factionName or "Reputation"
end,
init = function(trigger)
return "local standingID, barMin, barMax, barValue, factionName = WeakestAuras.FactionStanding(" .. fmt(trigger.factionName or "") .. ")\n"
.. "local exists = standingID ~= nil\n"
.. "local repValue = (barValue and barMin) and (barValue - barMin) or 0\n"
.. "local repMax = (barMax and barMin) and (barMax - barMin) or 1\n"
.. "standingID = standingID or 0"
end,
args = {
{ name = "factionName", type = "text", display = "Faction Name" },
{ name = "exists", type = "hidden", required = true, test = "exists" },
{ name = "standingID", type = "number", display = "Standing (1-8)", operator = ">=",
store = true, conditionType = "number" },
{ name = "repValue", type = "hidden", store = true, conditionType = "number", display = "Bar Value" },
{ name = "repMax", type = "hidden", store = true, conditionType = "number", display = "Bar Max" },
},
}
-- Player experience, static progress toward the next level. Guarded for max
-- level (UnitXPMax 0). restedXP is the bonus-rest pool (nil off rested).
PROTOTYPES["experience"] = {
displayName = "Experience",
wa2Event = "Experience",
category = "unit",
progressType = "static",
progressValue = "xp",
progressTotal = "xpMax",
events = function() return { "PLAYER_XP_UPDATE", "PLAYER_LEVEL_UP", "UPDATE_EXHAUSTION", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_Note_01",
iconFunc = function() return "Interface\\Icons\\INV_Misc_Note_01" end,
nameFunc = function() return "Experience" end,
init = function()
return "local xp = (UnitXP and UnitXP(\"player\")) or 0\n"
.. "local xpMax = (UnitXPMax and UnitXPMax(\"player\")) or 0\n"
.. "local restedXP = (GetXPExhaustion and GetXPExhaustion()) or 0\n"
.. "local xpPercent = (xpMax > 0) and (xp / xpMax * 100) or 0"
end,
args = {
{ name = "xp", type = "number", display = "XP", operator = ">=", store = true, conditionType = "number" },
{ name = "xpMax", type = "hidden", store = true, conditionType = "number", display = "Max XP" },
{ name = "xpPercent", type = "number", display = "XP (%)", operator = ">=", store = true, conditionType = "number" },
{ name = "restedXP", type = "hidden", store = true, conditionType = "number", display = "Rested XP" },
},
}
-- Character stats (raw values, not ratings -- vanilla has no rating system).
-- UnitStat's effective value is its 2nd return (base is 1st); captured via a
-- plain multi-assign, not an `and`-chain. Always active -- a status surface for
-- conditions/text, no required gate.
PROTOTYPES["charstats"] = {
displayName = "Character Stats",
wa2Event = "Character Stats",
category = "unit",
progressType = "none",
events = function() return { "UNIT_STATS", "UNIT_ATTACK_POWER", "UNIT_AURA", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
icon = "Interface\\Icons\\INV_Misc_GroupLooking",
iconFunc = function() return "Interface\\Icons\\INV_Misc_GroupLooking" end,
nameFunc = function() return "Character Stats" end,
init = function()
return "local function _stat(i) local b, e = UnitStat(\"player\", i) return e or b or 0 end\n"
.. "local strength = UnitStat and _stat(1) or 0\n"
.. "local agility = UnitStat and _stat(2) or 0\n"
.. "local stamina = UnitStat and _stat(3) or 0\n"
.. "local intellect = UnitStat and _stat(4) or 0\n"
.. "local spirit = UnitStat and _stat(5) or 0\n"
.. "local attackPower = 0\n"
.. "if UnitAttackPower then local ab, ap, an = UnitAttackPower(\"player\") attackPower = (ab or 0) + (ap or 0) - (an or 0) end"
end,
args = {
{ name = "strength", type = "number", display = "Strength", operator = ">=", store = true, conditionType = "number" },
{ name = "agility", type = "number", display = "Agility", operator = ">=", store = true, conditionType = "number" },
{ name = "stamina", type = "number", display = "Stamina", operator = ">=", store = true, conditionType = "number" },
{ name = "intellect", type = "number", display = "Intellect", operator = ">=", store = true, conditionType = "number" },
{ name = "spirit", type = "number", display = "Spirit", operator = ">=", store = true, conditionType = "number" },
{ name = "attackPower", type = "number", display = "Attack Power", operator = ">=", store = true, conditionType = "number" },
},
}
-- Crowd control on the player, timed progress. Debuff scan (WA.ScanPlayerCC)
-- against the bundled category table -- ClassicAPI-only, no combat log or
-- Nampower needed, and player-unit aura timing is the reliable case. Optional
-- category filter; name/icon/expiration drive the display. WA_SLOW_TICK flips it
-- off at expiry; UNIT_AURA catches a new/removed debuff immediately.
PROTOTYPES["crowdcontrol"] = {
displayName = "Crowd Control",
wa2Event = "Crowd Controlled",
category = "unit",
progressType = "timed",
events = function() return { "UNIT_AURA", "PLAYER_AURAS_CHANGED", "WA_SLOW_TICK" } end,
force_events = true,
loadFunc = function() WA.EnsureSlowTick() end,
icon = "Interface\\Icons\\Spell_Nature_Polymorph",
iconFunc = function() return "Interface\\Icons\\Spell_Nature_Polymorph" end,
nameFunc = function() return "Crowd Control" end,
init = function()
return "local active, category, name, icon, expirationTime, duration = WeakestAuras.ScanPlayerCC()"
end,
args = {
{ name = "active", type = "hidden", required = true, test = "active",
store = true, conditionType = "bool", display = "Under Control" },
{ name = "category", type = "select", display = "Category",
valueList = { "CC", "Silence", "Disarm", "Root", "Snare" },
test = function(t) return t.use_category and ("(category == " .. fmt(t.category) .. ")") or nil end },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = "Spell Name" },
{ name = "icon", type = "hidden", store = true },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
},
}
-- Range to a unit, status. A standalone wrapper over the three range primitives,
-- selected by `rangeMode`:
-- "unit" -- UnitInRange: a real ~40yd position check (ClassicAPI), the
-- same primitive the spell-cooldown/health prototypes expose.
-- "interact" -- CheckInteractDistance(unit, index): coarse native bands, the
-- ONLY way to detect short/melee range here (inspect ~28 /
-- trade ~11 / duel ~10 / follow ~28 yd -- index 3 is the
-- melee-ish band UnitInRange's 40yd can't resolve).
-- "spell" -- WA.SpellInRange: SpellHasRange-gated UnitInRange for a named
-- spell (exact per-spell range would need SuperWoW SpellInfo +
-- UnitPosition -- an opt-in refinement, not wired here).
-- Range changes with movement and there's no movement event, so it leans on
-- WA_FAST_TICK's 0.1s cadence to re-poll (plus a target swap) -- smooth enough
-- for a live distance readout. `distance` is the center-to-center yards from
-- UnitDistanceSquared (ClassicAPI), 0 when the position isn't available.
-- UnitInRange returns (inRange, checkedRange); captured via a direct
-- multi-assign inside the guard, never an `and`-chain (which truncates
-- multi-returns to one value here).
PROTOTYPES["rangecheck"] = {
displayName = "Range Check",
wa2Event = "Range Check",
category = "unit",
progressType = "none",
events = function() return { "PLAYER_TARGET_CHANGED", "WA_FAST_TICK", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
loadFunc = function() WA.EnsureFastTick() end,
icon = "Interface\\Icons\\Ability_Hunter_SniperShot",
iconFunc = function() return "Interface\\Icons\\Ability_Hunter_SniperShot" end,
nameFunc = function(trigger)
local unit = WA.TriggerUnit(trigger, "target")
return UnitName(unit) or unit
end,
init = function(trigger)
local mode = trigger.rangeMode or "unit"
local src = "local unit = " .. fmt(WA.TriggerUnit(trigger, "target")) .. "\n"
.. "local exists = UnitExists(unit) and true or false\n"
.. "local inRange, checkedRange = false, false\n"
.. "local distance, checkedDistance = 0, false\n"
if mode == "interact" then
src = src .. "if exists and CheckInteractDistance then "
.. "inRange = CheckInteractDistance(unit, " .. fmt(trigger.interactIndex or 3) .. ") and true or false "
.. "checkedRange = true end"
elseif mode == "spell" then
src = src .. "local spellId = " .. fmt(WA.ResolveSpellID(trigger.spellName) or 0) .. "\n"
.. "if exists and spellId > 0 then "
.. "inRange = WeakestAuras.SpellInRange(spellId, unit) "
.. "checkedRange = true end"
else
src = src .. "if exists and UnitInRange then local _r, _c = UnitInRange(unit) "
.. "inRange = _r and true or false checkedRange = _c and true or false end"
end
-- Center-to-center yards, independent of the mode's boolean check, so a
-- distance readout and a distance filter work in every mode. A real 0
-- (self, co-located) is indistinguishable from the miss placeholder, so
-- checkedDistance records whether the position was actually read; the
-- distance filter gates on it rather than trusting the 0.
src = src .. "\nif exists and UnitDistanceSquared then "
.. "local _dsq, _chk = UnitDistanceSquared(unit) "
.. "if _chk then distance = math.sqrt(_dsq) checkedDistance = true end end"
return src
end,
args = {
{ name = "unit", type = "unit", display = "Unit", default = "target" },
{ name = "rangeMode", type = "select", required = true, display = "Range Mode",
valueList = { "unit", "interact", "spell" },
valueLabels = { unit = "Unit (40yd)", interact = "Interact Band", spell = "Spell Range" },
default = "unit", reloadOptions = true,
-- The mode is baked into init's branch, not a runtime local, so it
-- contributes no test of its own.
test = function() return nil end },
{ name = "interactIndex", type = "select", required = true, display = "Interact Band",
valueList = { 1, 2, 3, 4 },
valueLabels = { [1] = "Inspect (~28yd)", [2] = "Trade (~11yd)", [3] = "Duel (~10yd)", [4] = "Follow (~28yd)" },
default = 3,
-- The band index is baked into the CheckInteractDistance call in init,
-- not a runtime local, so it contributes no test of its own.
test = function() return nil end,
enable = function(trigger) return (trigger.rangeMode or "unit") == "interact" end },
{ name = "spellName", type = "spell", display = "Spell (for Spell Range)",
enable = function(trigger) return (trigger.rangeMode or "unit") == "spell" end },
{ name = "exists", type = "hidden", required = true, test = "exists" },
-- `distance` is a local from init; the arg only adds the optional filter
-- and the store, so it declares no init of its own (a `local distance =
-- distance` would shadow the real one with nil). The filter gates on
-- checkedDistance so an unknown position (0 placeholder) can't pass a
-- `<=` test.
{ name = "distance", type = "number", display = "Distance", operator = "<=",
store = true, conditionType = "number",
test = function(trigger)
if not trigger.use_distance then return nil end
local op = safeOp(trigger.distance_operator or "<=")
return string.format("checkedDistance and (distance %s %s)", op, fmt(trigger.distance or 0))
end },
{ name = "inRange", type = "hidden", store = true, conditionType = "bool", display = "In Range" },
{ name = "checkedRange", type = "hidden", store = true, conditionType = "bool", display = "Range Checkable" },
{ name = "inRangeFilter", type = "toggle", display = "Only if In Range",
test = function(t) return t.inRangeFilter and "inRange" or nil end },
},
}
-- Threat, static progress. No Lua threat API on 1.12; TWThreat drives Turtle's
-- server-side threat query and broadcasts it. We consume its CHAT_MSG_ADDON
-- packets via WA.WatchThreat (below) and never send, so there's no protocol
-- risk -- it just needs someone in the group running TWThreat and an elite/boss
-- target for packets to arrive. `exists` stays false (trigger hidden) until the
-- first packet naming the player lands. threatpct is 0..100 (the player's threat
-- as a percentage of the tank's / aggro threshold).
PROTOTYPES["threat"] = {
displayName = "Threat (TWThreat)",
wa2Event = "Threat Situation",
category = "unit",
progressType = "static",
progressValue = "threatpct",
progressTotal = "threatmax",
events = function() return { "WA_THREAT_CHANGED", "PLAYER_TARGET_CHANGED" } end,
force_events = true,
loadFunc = function() WA.WatchThreat() end,
icon = "Interface\\Icons\\Ability_Threaten",
iconFunc = function() return "Interface\\Icons\\Ability_Threaten" end,
nameFunc = function() return "Threat" end,
init = function()
return "local threatpct, isTanking, exists = WeakestAuras.ThreatInfo()\n"
.. "local threatmax = 100"
end,
args = {
{ name = "exists", type = "hidden", required = true, test = "exists" },
{ name = "threatpct", type = "number", display = "Threat (%)", operator = ">=",
store = true, conditionType = "number" },
{ name = "threatmax", type = "hidden", store = true, conditionType = "number", display = "Threat Max" },
{ name = "isTanking", type = "hidden", store = true, conditionType = "bool", display = "Tanking" },
},
}
-- Totem in a given element slot, timed progress. No GetTotemInfo on 1.12; the
-- totem watcher (below) emulates it from a bundled spellID->duration DB + a
-- Nampower SPELL_GO_SELF drop signal. Per-slot default icon/name are
-- compile-time constants; the live totem's name/icon come from the watcher's
-- stores and win via activateEvent. Early-destroyed totems (killed, or the slot
-- overwritten) aren't detected mid-life beyond WA_SLOW_TICK expiry +
-- PLAYER_DEAD clear -- same limitation as the pfUI/CallOfElements refs.
local TOTEM_SLOT_LABELS = { [1] = "Fire", [2] = "Earth", [3] = "Water", [4] = "Air" }
local TOTEM_SLOT_ICONS = {
[1] = "Interface\\Icons\\Spell_Fire_SearingTotem",
[2] = "Interface\\Icons\\Spell_Nature_StrengthOfEarthTotem02",
[3] = "Interface\\Icons\\Spell_Nature_ManaRegenTotem",
[4] = "Interface\\Icons\\Spell_Nature_InvisibilityTotem",
}
PROTOTYPES["totem"] = {
displayName = "Totem",
wa2Event = "Totem",
category = "spell",
progressType = "timed",
events = function() return { "WA_TOTEM_UPDATE", "WA_SLOW_TICK", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
loadFunc = function() WA.WatchTotems(); WA.EnsureSlowTick() end,
icon = "Interface\\Icons\\Spell_Nature_SearingTotem",
migrate = function(trigger) renameArg(trigger, "totemSlot", "totemType") end,
iconFunc = function(trigger) return TOTEM_SLOT_ICONS[trigger.totemType or 1] or "Interface\\Icons\\Spell_Nature_SearingTotem" end,
nameFunc = function(trigger) return (TOTEM_SLOT_LABELS[trigger.totemType or 1] or "Totem") .. " Totem" end,
init = function(trigger)
return "local totemType = " .. fmt(trigger.totemType or 1) .. "\n"
.. "local active, name, icon, startTime, duration = WeakestAuras.TotemInfo(totemType)\n"
.. "active = active and true or false\n"
.. "startTime = startTime or 0\n"
.. "duration = duration or 0\n"
.. "local expirationTime = (startTime > 0 and duration > 0) and (startTime + duration) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0"
end,
args = {
{ name = "totemType", type = "select", required = true, display = "Element",
valueList = { 1, 2, 3, 4 }, valueLabels = TOTEM_SLOT_LABELS, default = 1 },
{ name = "active", type = "hidden", required = true, test = "active",
store = true, conditionType = "bool", display = "Active" },
{ name = "remaining", type = "number", display = "Remaining Time", operator = "<=" },
{ name = "name", type = "hidden", store = true, conditionType = "string", display = "Totem Name" },
{ name = "icon", type = "hidden", store = true },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Duration" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
},
}
-- Swing timer, timed progress per weapon hand. Full port of pfUI's
-- modules/swingtimer.lua: the watcher (below) maintains each hand's swing
-- start/duration off Nampower's AUTO_ATTACK_SELF reset + UnitAttackSpeed, the
-- Flurry proc-latency rescale, and the advanced grafts -- on-next-swing consume
-- (Heroic Strike/Cleave/Maul), the Slam/Hammer-of-Wrath clip warning,
-- ability-queue coloring, ranged bar, and parry haste. Those extras are
-- surfaced as condition variables (blocked/clipWarning/clipDelay/queuedAbility),
-- not a hardcoded bar tint -- the WA-idiomatic translation of pfUI's inline
-- rendering (see the watcher comment).
PROTOTYPES["swing"] = {
displayName = "Swing Timer",
wa2Event = "Swing Timer",
category = "unit",
progressType = "timed",
events = function() return { "WA_SWING_UPDATE", "WA_SLOW_TICK", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
loadFunc = function() WA.WatchSwing(); WA.EnsureSlowTick() end,
icon = "Interface\\Icons\\Ability_Warrior_DecisiveStrike",
iconFunc = function() return "Interface\\Icons\\Ability_Warrior_DecisiveStrike" end,
migrate = function(trigger) renameArg(trigger, "swingHand", "hand") end,
nameFunc = function(trigger)
local h = trigger.hand or "main"
return ((h == "off" and "Off Hand") or (h == "ranged" and "Ranged") or "Main Hand") .. " Swing"
end,
init = function(trigger)
return "local hand = " .. fmt(trigger.hand or "main") .. "\n"
.. "local active, startTime, duration, blocked, clipWarning, clipDelay, queuedAbility = WeakestAuras.SwingInfo(hand)\n"
.. "active = active and true or false\n"
.. "startTime = startTime or 0\n"
.. "duration = duration or 0\n"
.. "blocked = blocked and true or false\n"
.. "clipWarning = clipWarning and true or false\n"
.. "clipDelay = clipDelay or 0\n"
.. "queuedAbility = queuedAbility or \"none\"\n"
.. "local expirationTime = (startTime > 0 and duration > 0) and (startTime + duration) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0"
end,
args = {
{ name = "hand", type = "select", required = true, display = "Weapon",
valueList = { "main", "off", "ranged" },
valueLabels = { main = "Main Hand", off = "Off Hand", ranged = "Ranged" },
default = "main" },
{ name = "active", type = "hidden", required = true, test = "active",
store = true, conditionType = "bool", display = "Swinging" },
{ name = "remaining", type = "number", display = "Remaining Time", operator = "<=" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Swing Speed" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Remaining Time" },
-- Main-hand-only extras (Slam/HoW clip, ability queue), surfaced as
-- condition variables the user binds to color/text (no bar-owned tint).
{ name = "blocked", type = "hidden", store = true, conditionType = "bool", display = "Blocked (casting)" },
{ name = "clipWarning", type = "hidden", store = true, conditionType = "bool", display = "Clip Warning" },
{ name = "clipDelay", type = "hidden", store = true, conditionType = "number", display = "Clip Delay" },
{ name = "queuedAbility", type = "hidden", store = true, conditionType = "string", display = "Queued Ability" },
},
}
-- Power tick, timed progress, read from WA.WatchPowerTick's inferred cache --
-- no client event fires on the regen tick itself. Inference drifts on a missed
-- or batched power event, and in vanilla spending power does not reset the
-- tick -- both expected, not bugs.
PROTOTYPES["powertick"] = {
displayName = "Power Tick",
category = "unit",
progressType = "timed",
events = function() return { "WA_POWERTICK_UPDATE", "WA_SLOW_TICK", "PLAYER_ENTERING_WORLD" } end,
force_events = true,
loadFunc = function() WA.WatchPowerTick(); WA.EnsureSlowTick() end,
icon = "Interface\\Icons\\Spell_Nature_Lightning",
iconFunc = function() return "Interface\\Icons\\Spell_Nature_Lightning" end,
nameFunc = function() return "Power Tick" end,
init = function(trigger)
return "local active, startTime, duration = WeakestAuras.PowerTickInfo()\n"
.. "active = active and true or false\n"
.. "startTime = startTime or 0\n"
.. "duration = duration or 0\n"
.. "local expirationTime = (startTime > 0 and duration > 0) and (startTime + duration) or 0\n"
.. "local remaining = (expirationTime > 0 and (expirationTime - GetTime())) or 0"
end,
args = {
{ name = "active", type = "hidden", required = true, test = "active",
store = true, conditionType = "bool", display = "Ticking" },
{ name = "remaining", type = "number", display = "Time to Tick", operator = "<=" },
{ name = "duration", type = "hidden", store = true, conditionType = "number", display = "Tick Interval" },
{ name = "expirationTime", type = "hidden", store = true, conditionType = "timer", display = "Time to Tick" },
},
}
-- ---------------------------------------------------------------------------
-- Cooldown watchers (§4.4): one central cache per cooldown *kind* (spell/
-- item/equipment-slot), each polled on its own game-cooldown events + a
-- shared-shape slow ticker, translating the raw API into internal
-- <KIND>_COOLDOWN_CHANGED / _READY events prototypes consume declaratively.
-- Item and equipment-slot cooldowns are a near-clone of the spell-cooldown
-- watcher, so newCooldownWatcher factors the shared cache/ready-timer machinery
-- out once instead of copy-pasting it three times.
-- ---------------------------------------------------------------------------
-- spec: { pollRaw(key) -> start, duration, enabled; changedEvent, readyEvent;
-- extraEvents = { ... } (pcall-registered on the watcher's own frame, e.g.
-- SPELL_UPDATE_COOLDOWN) }. Returns { Watch(key, wantTick), Info(key) }.
-- `cache` is what the API last said and `announced` is what subscribers were
-- last told. They are separate on purpose: `cache` is refreshed on every read,
-- so no trigger ever evaluates a stale window, and comparing a poll against
-- `cache` would then let a read that happened to land between two polls swallow
-- the change event every *other* aura on that key is owed.
local function newCooldownWatcher(spec)
local w = { keys = {}, tick = {}, cache = {}, announced = {}, frame = nil, ticker = nil }
-- Emits nothing, so generated trigger code -- which already runs inside a
-- scan -- can call it without re-entering dispatch.
local function refresh(key)
local start, duration, enabled = spec.pollRaw(key)
w.cache[key] = { start = start or 0, duration = duration or 0, enabled = enabled }
return w.cache[key]
end
local function pollKey(key)
local c = refresh(key)
local a = w.announced[key]
local changed = not a or a.start ~= c.start or a.duration ~= c.duration
local running = c.start > 0 and c.duration > 0 and (c.start + c.duration) > GetTime()
-- Fire on a real change, and additionally every tick while a remaining-time
-- filter is interested (w.tick), so its threshold flips near real time
-- rather than only at start/end -- a running cooldown emits no natural event.
if changed or (w.tick[key] and running) then
w.announced[key] = { start = c.start, duration = c.duration }
WA.ScanEvents(spec.changedEvent, key)
end
-- Schedule the ready flip for real cooldowns, so the display clears
-- exactly on time without relying on the ticker's cadence. A window no
-- longer than the global cooldown is skipped: it is the GCD passing over
-- the spell, not its own cooldown, and arming a timer for every one of
-- those would mean a timer per watched key per cast.
if changed and running and not WA.IsGcdCooldown(c.duration) then
local remain = (c.start + c.duration) - GetTime()
if remain > 0 then
C_Timer.After(remain + 0.05, function()
pollKey(key)
WA.ScanEvents(spec.readyEvent, key)
end)
end
end
return running
end
local pollAll
-- The poll runs only while something is actually on cooldown. An idle key has
-- nothing a pass could discover that the client's own cooldown events do not
-- already deliver, so a watcher whose keys are all ready costs nothing --
-- which matters because keys are never released (see Watch below). Upstream
-- suspends its equivalent the same way: cdReadyFrame hides itself, stopping
-- its OnUpdate, whenever no work is marked pending.
--
-- The events on w.frame are what start it again, so this trades the old
-- always-on pass for a dependency on one of them arriving when a cooldown
-- begins. They are the canonical ones for each kind and the per-cooldown
-- expiry timer above still closes the window regardless.
local function syncTicker(running)
if running and not w.ticker then
w.ticker = C_Timer.NewTicker(0.3, function() pollAll() end)
elseif not running and w.ticker then
w.ticker:Cancel()
w.ticker = nil
end
end
pollAll = function()
local running = false
for key in pairs(w.keys) do
if pollKey(key) then running = true end
end
syncTicker(running)
end
local function ensure()
if w.frame then return end
w.frame = CreateFrame("Frame")
w.frame:SetScript("OnEvent", pollAll)
-- Guarded: not every 1.12 build fires every one of these, and an unknown
-- event name would error the whole registration (risk (c), settle per
-- build with Debug.lua's /wa events pattern).
for i = 1, table.getn(spec.extraEvents or {}) do
pcall(w.frame.RegisterEvent, w.frame, spec.extraEvents[i])
end
end
-- Registers a key in the central cooldown cache. wantTick asks the watcher to
-- re-emit changedEvent every ticker pass while this key is on cooldown (for
-- remaining-time filters).
--
-- Keys are never released, which is deliberate rather than unfinished:
-- upstream has no unwatch either (its `items[id] = true` is likewise set once
-- and never cleared, and the refcount on SpellDetails.watched exists to remap
-- a spell whose override changed, not to free anything on unload). The cost
-- of a key nothing displays any more is one API read per pass, and only while
-- some *other* key is running -- syncTicker above is what makes that true.
local function watch(key, wantTick)
w.keys[key] = true
if wantTick then w.tick[key] = true end
ensure()
if pollKey(key) then syncTicker(true) end
end
-- Generated cooldown-trigger code reads the cache through this. Refreshing
-- first is what makes it answer for a key nothing has registered yet -- a
-- force_events pass runs before loadFunc -- and keeps a read that arrives
-- between two polls current.
local function info(key)
local c = refresh(key)
return c.start, c.duration, c.enabled
end
return { Watch = watch, Info = info }
end
-- C_Spell.GetSpellCooldown and vanilla's GetSpellCooldown(slot, BOOKTYPE_SPELL)
-- are the same read: ClassicAPI's Script_C_Spell_GetSpellCooldown calls
-- FUN_SPELL_QUERY_COOLDOWN(spellID, bookType=0), which is the helper the slot
-- form reaches after resolving the slot to a spellID (ref ClassicAPI
-- src/spell/Cooldown.cpp). The spellID form is the one to use: the slot form
-- additionally requires the spell to sit in the player's book, so it cannot
-- answer for a talent passive or a profession recipe.
--
-- What this read depends on is the *identity* handed to it -- a spellID with no
-- Spell.dbc row answers nil, and a rank other than the one actually cast has no
-- cooldown of its own. That resolution is WA.ResolveSpellID's job, not this one's.
--
-- The start goes through WA.UnwrapTick: this is one of the two ClassicAPI reads
-- that hand back a signed-wrapped tick on a long-lived client.
local spellCdWatch = newCooldownWatcher({
pollRaw = function(spellId)
local cdInfo = C_Spell and C_Spell.GetSpellCooldown and C_Spell.GetSpellCooldown(spellId)
if not cdInfo then return nil, nil, nil end
return WA.UnwrapTick(cdInfo.startTime), cdInfo.duration, cdInfo.isEnabled
end,
changedEvent = "SPELL_COOLDOWN_CHANGED",
readyEvent = "SPELL_COOLDOWN_READY",
extraEvents = { "SPELL_UPDATE_COOLDOWN", "SPELL_UPDATE_USABLE", "ACTIONBAR_UPDATE_COOLDOWN" },
})
function WA.WatchSpellCooldown(spellId, wantTick) spellCdWatch.Watch(spellId, wantTick) end
function WA.SpellCdInfo(spellId) return spellCdWatch.Info(spellId) end
-- Whether the client has a cooldown record for this spell at all. An id with no
-- Spell.dbc row -- a name that resolved to nothing, a rank that does not exist,
-- a hand-typed number -- reads back as a zero-length cooldown, which is
-- indistinguishable from "ready" unless it is asked about separately. A trigger
-- pointed at a spell the client cannot identify should stay dark rather than
-- claim the spell is permanently off cooldown.
function WA.SpellCdKnown(spellId)
if not spellId or spellId == 0 then return false end
if not (C_Spell and C_Spell.GetSpellCooldown) then return false end
return C_Spell.GetSpellCooldown(spellId) ~= nil
end
-- GetItemCooldown returns (start, duration, enable) directly, not a table --
-- read behind an if-guard (not an `and`-chain) so all three values actually
-- propagate; `and`-chaining a multi-return call truncates it to one value on
-- this client's Lua 5.0.
--
-- The start goes through WA.UnwrapTick: this is the other ClassicAPI read that
-- hands back a signed-wrapped tick on a long-lived client. The equipment-slot
-- watcher below needs no such repair -- GetInventoryItemCooldown is vanilla's own.
local itemCdWatch = newCooldownWatcher({
pollRaw = function(itemId)
if not GetItemCooldown then return 0, 0, false end
local start, duration, enable = GetItemCooldown(itemId)
return WA.UnwrapTick(start), duration, enable == 1
end,
changedEvent = "ITEM_COOLDOWN_CHANGED",
readyEvent = "ITEM_COOLDOWN_READY",
extraEvents = { "BAG_UPDATE_COOLDOWN" },
})
function WA.WatchItemCooldown(itemId, wantTick) itemCdWatch.Watch(itemId, wantTick) end
function WA.ItemCdInfo(itemId) return itemCdWatch.Info(itemId) end
-- GetInventoryItemCooldown is a native 1.12 global (not a ClassicAPI
-- backport), same (start, duration, enable) shape as GetItemCooldown.
local equipCdWatch = newCooldownWatcher({
pollRaw = function(slot)
if not GetInventoryItemCooldown then return 0, 0, false end
local start, duration, enable = GetInventoryItemCooldown("player", slot)
return start, duration, enable == 1
end,
changedEvent = "EQUIPSLOT_COOLDOWN_CHANGED",
readyEvent = "EQUIPSLOT_COOLDOWN_READY",
extraEvents = { "BAG_UPDATE_COOLDOWN", "PLAYER_EQUIPMENT_CHANGED" },
})
function WA.WatchEquipSlotCooldown(slot, wantTick) equipCdWatch.Watch(slot, wantTick) end
function WA.EquipSlotCdInfo(slot) return equipCdWatch.Info(slot) end
-- Threat watcher: parses TWThreat's CHAT_MSG_ADDON broadcasts into a cached
-- threat percentage for the player, re-emitting WA_THREAT_CHANGED so the threat
-- prototype re-reads it (the incoming addon message is just another event
-- feeding a status update -- fits the existing model with no engine change).
-- Packet body: "...TWTv4=name:tank:threat:perc:melee:extra;name2:...;" (ref
-- TWThreat.lua handleThreatPacket). Plain string.find/sub splitting -- this
-- client's Lua 5.0 has no gmatch, and the fields are magic-char-free anyway.
local threatCache = { pct = 0, isTanking = false, exists = false }
local threatFrame
local function splitStr(s, sep)
local out, pos = {}, 1
while true do
local a, b = string.find(s, sep, pos, true)
if not a then table.insert(out, string.sub(s, pos)); break end
table.insert(out, string.sub(s, pos, a - 1))
pos = b + 1
end
return out
end
function WA.WatchThreat()
if threatFrame then return end
threatFrame = CreateFrame("Frame")
-- Guarded like every other event registration here (risk (c)); CHAT_MSG_ADDON
-- is a native 1.12 event so it should always take.
pcall(threatFrame.RegisterEvent, threatFrame, "CHAT_MSG_ADDON")
threatFrame:SetScript("OnEvent", function()
if arg1 ~= "TWT" or not arg2 then return end
local s, e = string.find(arg2, "TWTv4=", 1, true)
if not s then return end
local players = splitStr(string.sub(arg2, e + 1), ";")
local me = UnitName("player")
local found = false
for i = 1, table.getn(players) do
local f = splitStr(players[i], ":")
if f[1] == me and f[4] then
threatCache.pct = tonumber(f[4]) or 0
threatCache.isTanking = f[2] == "1"
threatCache.exists = true
found = true
end
end
if found then WA.ScanEvents("WA_THREAT_CHANGED") end
end)
end
function WA.ThreatInfo() return threatCache.pct, threatCache.isTanking, threatCache.exists end
-- Shared SPELL_GO_SELF dispatch: the totem and swing watchers both consume this
-- Nampower event (arg1 itemId, 0 for a real spell cast; arg2 spellId -- ref
-- DoiteAuras DoiteConditions.lua ~2270). Registered once and fanned out to
-- subscribers so the two watchers don't each stand up their own frame, and the
-- gating CVar is flipped once: Nampower hides SPELL_GO events behind
-- NP_EnableSpellGoEvents (default 0), enabled here the same guarded way
-- DoiteAuras does -- without it arg2/spellId never arrives.
local spellGoSelfSubs = {}
local spellGoSelfFrame
local function subscribeSpellGoSelf(fn)
table.insert(spellGoSelfSubs, fn)
if spellGoSelfFrame then return end
if GetCVar and SetCVar then
local ok, v = pcall(GetCVar, "NP_EnableSpellGoEvents")
if ok and v and tostring(v) == "0" then pcall(SetCVar, "NP_EnableSpellGoEvents", "1") end
end
spellGoSelfFrame = CreateFrame("Frame")
pcall(spellGoSelfFrame.RegisterEvent, spellGoSelfFrame, "SPELL_GO_SELF")
spellGoSelfFrame:SetScript("OnEvent", function()
if arg1 and arg1 ~= 0 then return end -- item-triggered, not a real spell cast
local spellId = arg2
if not spellId then return end
for i = 1, table.getn(spellGoSelfSubs) do spellGoSelfSubs[i](spellId) end
end)
end
-- ---------------------------------------------------------------------------
-- Global cooldown (§4.4). Upstream's CheckGCD reads a start and duration
-- straight off a dedicated GCD spell -- GetSpellCooldown(29515) on Classic,
-- 61304 elsewhere. Neither ID exists here: they have no 1.12 Spell.dbc row, and
-- this client's GetSpellCooldown takes a spellbook *slot* plus bookType rather
-- than a spellID, so handing it one raises "invalid spell slot" instead of
-- looking anything up.
--
-- What is readable is the same call used the way vanilla means it:
-- GetSpellCooldown(slot, BOOKTYPE_SPELL) answers a true start and duration in
-- GetTime()'s epoch, and a slot whose spell has no cooldown of its own shows
-- the global cooldown and nothing else. So the GCD is read off exactly one such
-- slot, learned from what the player actually casts -- after a SPELL_GO_SELF
-- the caster's own slot either reports a GCD-length window (a usable probe,
-- remembered) or a longer one (the spell's own cooldown, keep looking).
--
-- Before a probe is learned the window is latched at the cast instead. Latching
-- rather than re-deriving is the point: a source that only reports a *remaining*
-- time re-reads as a fresh full-length window on every poll, which is a bar that
-- restarts from full several times a second.
-- ---------------------------------------------------------------------------
-- Longest window still attributable to the global cooldown. The GCD is 1.5s and
-- server latency lands the reported window slightly over it.
local GCD_MAX = 1.6
local GCD_DEFAULT = 1.5
local gcd = { start = 0, duration = 0, measured = nil, probeSlot = nil, generation = 0 }
local function gcdEnd()
if gcd.duration == 0 then return end
gcd.generation = gcd.generation + 1
gcd.start, gcd.duration = 0, 0
WA.ScanEvents("GCD_END")
end
-- Closes the window on its own schedule, so the display clears on time whether
-- or not another cooldown event happens to arrive. The generation stamp makes a
-- timer from a superseded window a no-op instead of ending the current one.
local function gcdSchedule()
local remain = (gcd.start + gcd.duration) - GetTime()
if remain <= 0 then return end
local generation = gcd.generation
C_Timer.After(remain + 0.05, function()
if gcd.generation == generation then gcdEnd() end
end)
end
local function gcdBegin(start, duration)
-- Same window seen again: keep the latched start and length. Re-deriving them
-- from a later read is what restarts a running bar.
if gcd.duration > 0 and math.abs((gcd.start + gcd.duration) - (start + duration)) < 0.1 then return end
gcd.generation = gcd.generation + 1
gcd.start, gcd.duration = start, duration
gcdSchedule()
WA.ScanEvents("GCD_UPDATE")
end
local function gcdPoll()
local start, duration = WA.SpellSlotCooldown(gcd.probeSlot)
if start and duration and duration > 0 and duration <= GCD_MAX then
gcd.measured = duration
gcdBegin(start, duration)
elseif gcd.duration > 0 and (gcd.start + gcd.duration) <= GetTime() then
gcdEnd()
end
end
local function gcdOnCast(spellId)
-- Open the window on the cast itself, so the trigger is live before any probe
-- slot has been learned and stays live for a caster whose own cooldown is
-- longer than the GCD (its slot can never serve as a probe).
gcdBegin(GetTime(), gcd.measured or GCD_DEFAULT)
local slot = WA.SpellSlotByID(spellId)
if not slot then return end
-- Read a frame later: the cooldown the server applied for this cast has not
-- landed on the slot at the instant SPELL_GO_SELF arrives.
C_Timer.After(0.05, function()
local start, duration = WA.SpellSlotCooldown(slot)
if start and duration and duration > 0 and duration <= GCD_MAX then
gcd.probeSlot = slot
gcd.measured = duration
gcdBegin(start, duration)
end
end)
end
local gcdFrame
function WA.WatchGCD()
if gcdFrame then return end
gcdFrame = CreateFrame("Frame")
-- Guarded like every other event registration here (risk (c)).
local events = { "ACTIONBAR_UPDATE_COOLDOWN", "SPELL_UPDATE_COOLDOWN", "SPELLS_CHANGED", "LEARNED_SPELL_IN_TAB" }
for i = 1, table.getn(events) do pcall(gcdFrame.RegisterEvent, gcdFrame, events[i]) end
gcdFrame:SetScript("OnEvent", function()
if event == "SPELLS_CHANGED" or event == "LEARNED_SPELL_IN_TAB" then
-- Slot numbers shift as the book grows, so the shared index and the
-- probe drawn from it both stop meaning anything.
WA.InvalidateSpellSlots()
gcd.probeSlot = nil
return
end
gcdPoll()
end)
subscribeSpellGoSelf(gcdOnCast)
end
-- (start, duration, enabled) of the open window, or (0, 0, true) when none is.
-- Reports an elapsed window as closed but does not close it: generated trigger
-- code calls this from inside a scan, and ending the window there would re-enter
-- dispatch. gcdSchedule's timer is what actually ends it and emits.
function WA.GcdInfo()
if gcd.duration > 0 and (gcd.start + gcd.duration) <= GetTime() then return 0, 0, true end
return gcd.start, gcd.duration, true
end
-- True when a cooldown window is the global cooldown passing over a spell or
-- item rather than its own. Nothing distinguishes the two here but length, so
-- this is the measured GCD compared against -- GCD_DEFAULT only until a cast has
-- been measured, which is why it is not the literal 1.5 it replaced.
function WA.IsGcdCooldown(duration)
if not duration or duration <= 0 then return false end
return duration <= (gcd.measured or GCD_DEFAULT) + 0.1
end
-- The watcher's internals, for Debug.lua's /wa gcd. Which slot it settled on and
-- what length it measured there are the two things the display cannot show and
-- the two the runtime is wrong about when the GCD misbehaves.
function WA.GcdDebug()
return { probeSlot = gcd.probeSlot, measured = gcd.measured, start = gcd.start,
duration = gcd.duration, watching = gcdFrame ~= nil }
end
-- Re-emits the shared dispatch as an internal event carrying the spell id, so a
-- trigger reads the cast off the payload instead of re-polling for it. Player
-- only: SPELL_GO_SELF does not fire for anyone else's casts.
local spellCastWatching = false
function WA.WatchSpellCast()
if spellCastWatching then return end
spellCastWatching = true
subscribeSpellGoSelf(function(spellId)
WA.ScanEvents("WA_SPELL_CAST_SUCCEEDED", spellId)
end)
end
-- Single-bit flag test (masks used here are all powers of two), so nothing
-- depends on a `bit` library being present -- AUTO_ATTACK_SELF hitInfo bits and
-- the Spell.dbc attribute/flag bits (via GetSpellRecField) both go through this.
local function hasFlag(v, f) return math.mod(math.floor(v / f), 2) == 1 end
-- Totem watcher: emulates a GetTotemInfo(slot) the way pfUI's libtotem /
-- CallOfElements do on this client -- there's no native one on 1.12. A totem
-- drop is a shared-dispatch SPELL_GO_SELF matched against a bundled spellID->
-- {slot,duration} DB (ported from pfUI libtotem; CallOfElements builds the same
-- data at runtime by name-scan, so the static table is the cleaner source),
-- committing {name,icon,start,duration} into the element slot. Totemic Recall/
-- Call clears every slot (name-matched, enUS -- we ship no ID for it and Turtle
-- may re-ID it). No early-death detection beyond expiry + PLAYER_DEAD (no event
-- fires when a totem is killed) -- matches the references' own limitation.
local TOTEM_SPELLS = {
-- FIRE (slot 1)
[1535] = { 1, 5 }, [8498] = { 1, 5 }, [8499] = { 1, 5 }, [11314] = { 1, 5 }, [11315] = { 1, 5 },
[8227] = { 1, 120 }, [8249] = { 1, 120 }, [10526] = { 1, 120 }, [16387] = { 1, 120 },
[8184] = { 1, 120 }, [10478] = { 1, 120 }, [10479] = { 1, 120 },
[8190] = { 1, 20 }, [10585] = { 1, 20 }, [10586] = { 1, 20 }, [10587] = { 1, 20 },
[3599] = { 1, 30 }, [6363] = { 1, 35 }, [6364] = { 1, 40 }, [6365] = { 1, 45 }, [10437] = { 1, 50 }, [10438] = { 1, 55 },
-- EARTH (slot 2)
[2484] = { 2, 45 }, [5730] = { 2, 15 }, [6390] = { 2, 15 }, [6391] = { 2, 15 }, [6392] = { 2, 15 },
[10427] = { 2, 15 }, [10428] = { 2, 15 },
[8071] = { 2, 120 }, [8154] = { 2, 120 }, [8155] = { 2, 120 }, [10406] = { 2, 120 }, [10407] = { 2, 120 }, [10408] = { 2, 120 },
[8075] = { 2, 120 }, [8160] = { 2, 120 }, [8161] = { 2, 120 }, [10442] = { 2, 120 }, [25361] = { 2, 120 },
[8143] = { 2, 120 },
-- WATER (slot 3)
[8170] = { 3, 120 }, [8185] = { 3, 120 }, [10537] = { 3, 120 }, [10538] = { 3, 120 },
[5394] = { 3, 60 }, [6375] = { 3, 60 }, [6377] = { 3, 60 }, [10462] = { 3, 60 }, [10463] = { 3, 60 },
[5675] = { 3, 60 }, [10495] = { 3, 60 }, [10496] = { 3, 60 }, [10497] = { 3, 60 },
[16190] = { 3, 12 }, [8166] = { 3, 120 },
-- AIR (slot 4)
[8835] = { 4, 120 }, [10627] = { 4, 120 }, [8177] = { 4, 45 },
[10595] = { 4, 120 }, [10600] = { 4, 120 }, [10601] = { 4, 120 }, [25359] = { 4, 120 },
[8512] = { 4, 120 }, [10613] = { 4, 120 }, [10614] = { 4, 120 },
[15107] = { 4, 120 }, [15421] = { 4, 120 }, [15422] = { 4, 120 },
}
local TOTEM_RECALL_NAMES = { ["Totemic Recall"] = true, ["Totemic Call"] = true }
local totemActive = {} -- slot -> { name, icon, start, duration }
local totemMiscFrame
local function totemClearAll()
local any = false
for slot in pairs(totemActive) do totemActive[slot] = nil; any = true end
if any then WA.ScanEvents("WA_TOTEM_UPDATE") end
end
function WA.WatchTotems()
if totemMiscFrame then return end
totemMiscFrame = CreateFrame("Frame")
pcall(totemMiscFrame.RegisterEvent, totemMiscFrame, "PLAYER_DEAD")
totemMiscFrame:SetScript("OnEvent", totemClearAll)
subscribeSpellGoSelf(function(spellId)
local data = TOTEM_SPELLS[spellId]
if data then
local name, _, icon = GetSpellInfo(spellId)
totemActive[data[1]] = { name = name, icon = icon, start = GetTime(), duration = data[2] }
WA.ScanEvents("WA_TOTEM_UPDATE")
return
end
local nm = GetSpellInfo(spellId)
if nm and TOTEM_RECALL_NAMES[nm] then totemClearAll() end
end)
end
-- (active, name, icon, start, duration) or nil once expired (self-cleaning, the
-- same shape pfUI's GetTotemInfo returns).
function WA.TotemInfo(slot)
local t = totemActive[slot]
if not t then return false end
if (t.start + t.duration) - GetTime() < 0 then
totemActive[slot] = nil
return false
end
return true, t.name, t.icon, t.start, t.duration
end
-- Swing-timer watcher: a faithful port of pfUI modules/swingtimer.lua's state
-- machine, translated from its bar+OnUpdate rendering to WeakestAuras' data
-- model --
-- each hand is stored as {active,start,duration} the region animates, and the
-- extra swing state (blocked / clip / queued ability) is surfaced as condition
-- variables instead of a hardcoded bar tint. State is consolidated into one
-- table to stay clear of Lua 5.0's 32-upvalue-per-closure limit (pfUI's S does
-- the same). All the Spell.dbc reads go through GetSpellRecField, a Nampower
-- accessor (used by pfUI + DoiteAuras, not a ClassicAPI backport) -- every call
-- is guarded so a build lacking it simply degrades to AUTO_ATTACK_SELF-only
-- resets (the shipped core behaviour).
local HITINFO_LEFTSWING, HITINFO_NOACTION = 4, 65536
local ATTR_ON_NEXT_SWING = 4 -- 0x04 replaces the next auto-attack swing
local FLAG_AUTOATTACK = 8 -- 0x08 interruptFlags: cast resets the swing
local ATTR_KEEP_SWINGS = 131072 -- 0x20000 attributesEx2: cast does NOT reset it
local SWING_PROC_LATENCY = 0.15
local WAND_SHOOT_SPELLID, THROW_SPELLID = 5019, 2764
-- OctoWoW re-IDs Slam and SPELL_START_SELF is silent for it, so swing-delay casts
-- are matched by NAME off SPELLCAST_START (rank/id-proof).
local SWING_DELAY_NAMES = { ["Slam"] = true, ["Hammer of Wrath"] = true }
-- Rank-1 canonical names (rank/locale-proof) for on-next-swing classification.
local HS_NAME = C_Spell and C_Spell.GetSpellName and C_Spell.GetSpellName(78)
local CLEAVE_NAME = C_Spell and C_Spell.GetSpellName and C_Spell.GetSpellName(845)
local MAUL_NAME = C_Spell and C_Spell.GetSpellName and C_Spell.GetSpellName(6807)
local swing = {
main = { active = false, start = 0, duration = 0 },
off = { active = false, start = 0, duration = 0 },
ranged = { active = false, start = 0, duration = 0 },
}
local sw = {
mhSpeed = 0, ohSpeed = 0, raSpeed = 0,
mhBlocked = false, mhClipWarn = false, mhClipDelay = 0,
queued = "none", useSQE = false,
isWarrior = false, hsSlots = {}, cleaveSlots = {},
playerGuid = nil, onSwingCache = {},
}
local swingFrame
local function swingUpdateSpeeds()
if UnitAttackSpeed then
local ms, os = UnitAttackSpeed("player")
if ms and ms > 0 then sw.mhSpeed = ms end
sw.ohSpeed = (os and os > 0) and os or 0
end
if UnitRangedDamage then
local rs = UnitRangedDamage("player")
sw.raSpeed = (rs and rs > 0) and rs or 0
end
end
-- Spell.dbc "replaces the next swing" bit (SPELL_ATTR_ON_NEXT_SWING), cached.
local function isOnSwingSpell(spellId)
local c = sw.onSwingCache[spellId]
if c ~= nil then return c end
local attr = (GetSpellRecField and GetSpellRecField(spellId, "attributes")) or 0
local r = hasFlag(attr, ATTR_ON_NEXT_SWING)
sw.onSwingCache[spellId] = r
return r
end
local function classifyOnSwing(spellId)
if not isOnSwingSpell(spellId) then return nil end
local name = C_Spell and C_Spell.GetSpellName and C_Spell.GetSpellName(spellId)
if name and name == HS_NAME then return "hs"
elseif name and name == CLEAVE_NAME then return "cleave"
elseif name and name == MAUL_NAME then return "maul" end
return nil
end
-- Action-bar slot cache: queue detection fallback for builds without Nampower's
-- SPELL_QUEUE_EVENT. Warriors only (HS/Cleave); rebuilt on bar/equipment change.
local function rebuildQueueSlots()
sw.hsSlots = {}; sw.cleaveSlots = {}
if not (sw.isWarrior and GetActionInfo) then return end
for slot = 1, 120 do
local kind, id = GetActionInfo(slot)
local name
if kind == "spell" then name = GetSpellInfo(id)
elseif kind == "macro" and GetMacroSpell then name = GetMacroSpell(id) end
if name and name == HS_NAME then table.insert(sw.hsSlots, slot)
elseif name and name == CLEAVE_NAME then table.insert(sw.cleaveSlots, slot) end
end
end
local function anyCurrentAction(slots)
if not IsCurrentAction then return false end
for i = 1, table.getn(slots) do
if IsCurrentAction(slots[i]) then return true end
end
return false
end
-- The on-next-swing ability currently queued (hs/cleave/maul/none). Nampower's
-- SPELL_QUEUE_EVENT is authoritative once the build fires it (sw.useSQE); else
-- poll the cached action slots live.
function WA.SwingQueued()
if sw.useSQE then return sw.queued end
if not sw.isWarrior then return "none" end
if anyCurrentAction(sw.cleaveSlots) then return "cleave" end
if anyCurrentAction(sw.hsSlots) then return "hs" end
return "none"
end
local function swingReset(hand)
swingUpdateSpeeds()
local speed = (hand == "off" and sw.ohSpeed) or (hand == "ranged" and sw.raSpeed) or sw.mhSpeed
if not speed or speed <= 0 then return end
local s = swing[hand]
s.start = GetTime(); s.duration = speed; s.active = true
if hand == "main" then sw.mhBlocked = false; sw.mhClipWarn = false; sw.mhClipDelay = 0 end
WA.ScanEvents("WA_SWING_UPDATE")
end
-- Ranged auto-attack: Auto Shot / Throw replace the melee swing clock; wand Shoot
-- leaves it running (casters weave), so replaceMH is false only there.
local function swingResetRanged(replaceMH)
swingUpdateSpeeds()
if sw.raSpeed <= 0 then return end
if replaceMH then swing.main.active = false end
local r = swing.ranged
r.start = GetTime(); r.duration = sw.raSpeed; r.active = true
WA.ScanEvents("WA_SWING_UPDATE")
end
-- Flurry: only a haste GAIN present at swing start (within the proc latency)
-- rescales the in-flight swing; preserve the elapsed fraction by shifting `start`
-- so (now-start)/newDur equals the old elapsed fraction.
local function swingRescale()
local now = GetTime()
local oldMh, oldOh = sw.mhSpeed, sw.ohSpeed
swingUpdateSpeeds()
local changed = false
local sm = swing.main
if sm.active and oldMh > 0 and sw.mhSpeed > 0 and sw.mhSpeed < oldMh
and (now - sm.start) < SWING_PROC_LATENCY then
local frac = (now - sm.start) / sm.duration
if frac < 0 then frac = 0 elseif frac > 1 then frac = 1 end
sm.duration = sw.mhSpeed; sm.start = now - frac * sw.mhSpeed; changed = true
end
local so = swing.off
if so.active and oldOh > 0 and sw.ohSpeed > 0 and sw.ohSpeed < oldOh
and (now - so.start) < SWING_PROC_LATENCY then
local frac = (now - so.start) / so.duration
if frac < 0 then frac = 0 elseif frac > 1 then frac = 1 end
so.duration = sw.ohSpeed; so.start = now - frac * sw.ohSpeed; changed = true
end
if changed then WA.ScanEvents("WA_SWING_UPDATE") end
end
-- Parry haste: the player parried (AUTO_ATTACK_OTHER victimState 3, victim = the
-- player) -> the nearest-to-firing melee swing is hastened 40% of weapon speed,
-- floored at 20% remaining (SP_SwingTimer's rule). Move `start` earlier, clamped.
local function swingParryHaste()
local now = GetTime()
local function apply(s, speed)
if not s.active or not speed or speed <= 0 then return false end
local remaining = (s.start + s.duration) - now
local minimum = speed * 0.20
if remaining <= minimum then return false end
local reduced = remaining - speed * 0.40
if reduced < minimum then reduced = minimum end
s.start = now - (s.duration - reduced)
return true
end
local m, o = swing.main, swing.off
local mFrac = (m.active and m.duration > 0) and (((m.start + m.duration) - now) / m.duration) or 2
local oFrac = (o.active and o.duration > 0) and (((o.start + o.duration) - now) / o.duration) or 2
local changed
if oFrac < mFrac then changed = apply(o, sw.ohSpeed) else changed = apply(m, sw.mhSpeed) end
if changed then WA.ScanEvents("WA_SWING_UPDATE") end
end
-- Swing-delay cast (Slam / Hammer of Wrath): the swing keeps ticking but the auto
-- can't fire until the cast ends. If the cast will finish AFTER the swing is
-- ready, the auto is clipped by (castDur - remaining) -- surfaced as clipWarning/
-- clipDelay. Called with a duration from SPELLCAST_START and with 0 from the
-- attribute-driven SPELL_START_SELF fallback, so a 0 only sets the block.
local function swingBeginDelayCast(castDur)
if not swing.main.active then return end
sw.mhBlocked = true
if castDur and castDur > 0 then
local remaining = (swing.main.start + swing.main.duration) - GetTime()
local clip = castDur - remaining
if clip > 0 then sw.mhClipWarn = true; sw.mhClipDelay = clip end
end
WA.ScanEvents("WA_SWING_UPDATE")
end
local function swingClearDelayCast()
if sw.mhBlocked or sw.mhClipWarn then
sw.mhBlocked = false; sw.mhClipWarn = false; sw.mhClipDelay = 0
WA.ScanEvents("WA_SWING_UPDATE")
end
end
-- Shared-dispatch SPELL_GO_SELF: a cast landed. Ranged auto-attacks reset the
-- ranged clock; on-next-swing abilities (HS/Cleave/Maul/Raptor/etc.) consume the
-- MH swing; otherwise mirror the server melee-reset rule (interruptFlags has
-- AUTOATTACK and attributesEx2 lacks KEEP_SWINGS). A blocked swing-delay cast
-- that doesn't reset just releases the hold.
local function swingOnSpellGo(spellId)
if C_Spell and C_Spell.IsRangedAutoAttackSpell and C_Spell.IsRangedAutoAttackSpell(spellId) then
swingResetRanged(spellId ~= WAND_SHOOT_SPELLID)
return
elseif spellId == THROW_SPELLID then
swingResetRanged(true)
return
elseif isOnSwingSpell(spellId) then
sw.queued = "none"
swingReset("main")
return
end
local iflags = (GetSpellRecField and GetSpellRecField(spellId, "interruptFlags")) or 0
local ex2 = (GetSpellRecField and GetSpellRecField(spellId, "attributesEx2")) or 0
if hasFlag(iflags, FLAG_AUTOATTACK) and not hasFlag(ex2, ATTR_KEEP_SWINGS) then
if swing.main.active then swingReset("main") end
if swing.off.active then swingReset("off") end
elseif sw.mhBlocked then
swingClearDelayCast()
end
end
function WA.WatchSwing()
if swingFrame then return end
local _, class = UnitClass("player")
sw.isWarrior = (class == "WARRIOR")
if UnitExists then local _, g = UnitExists("player"); sw.playerGuid = g end
swingUpdateSpeeds()
rebuildQueueSlots()
swingFrame = CreateFrame("Frame")
local evs = { "AUTO_ATTACK_SELF", "AUTO_ATTACK_OTHER", "START_AUTOATTACK",
"STOP_AUTOATTACK", "UNIT_ATTACK_SPEED", "PLAYER_EQUIPMENT_CHANGED",
"PLAYER_ENTERING_WORLD", "ACTIONBAR_SLOT_CHANGED", "SPELLCAST_START",
"SPELL_START_SELF", "SPELLCAST_FAILED", "SPELLCAST_INTERRUPTED",
"SPELL_QUEUE_EVENT" }
for i = 1, table.getn(evs) do pcall(swingFrame.RegisterEvent, swingFrame, evs[i]) end
swingFrame:SetScript("OnEvent", function()
if event == "AUTO_ATTACK_SELF" then
local hitInfo = arg4 or 0
local hand = hasFlag(hitInfo, HITINFO_LEFTSWING) and "off" or "main"
local s = swing[hand]
-- Server didn't advance the clock (dodge/parry/miss): leave a running
-- timer alone, but still start one that isn't active yet.
if hasFlag(hitInfo, HITINFO_NOACTION) and s.active then return end
-- Extra attack: >20% of the swing still remaining => the server did not
-- reset the clock, so this hit is an extra attack -- don't restart.
if s.active and s.duration > 0 then
local remaining = (s.start + s.duration) - GetTime()
if remaining > 0 and (remaining / s.duration) > 0.20 then return end
end
swingReset(hand)
elseif event == "AUTO_ATTACK_OTHER" then
if arg5 == 3 and (not sw.playerGuid or arg2 == sw.playerGuid) then swingParryHaste() end
elseif event == "UNIT_ATTACK_SPEED" then
if arg1 and arg1 ~= "player" then return end
swingRescale()
elseif event == "SPELLCAST_START" then
if arg1 and SWING_DELAY_NAMES[arg1] then swingBeginDelayCast((arg2 or 0) / 1000) end
elseif event == "SPELL_START_SELF" then
if arg1 and arg1 > 0 and swing.main.active then
local iflags = (GetSpellRecField and GetSpellRecField(arg1, "interruptFlags")) or 0
if not hasFlag(iflags, FLAG_AUTOATTACK) then swingBeginDelayCast(0) end
end
elseif event == "SPELLCAST_FAILED" or event == "SPELLCAST_INTERRUPTED" then
swingClearDelayCast()
elseif event == "SPELL_QUEUE_EVENT" then
if arg1 == 0 then
sw.useSQE = true
local k = classifyOnSwing(arg2 or 0)
if k then sw.queued = k end
elseif arg1 == 1 then
sw.queued = "none"
end
WA.ScanEvents("WA_SWING_UPDATE")
elseif event == "STOP_AUTOATTACK" then
swing.main.active = false; swing.off.active = false
WA.ScanEvents("WA_SWING_UPDATE")
elseif event == "ACTIONBAR_SLOT_CHANGED" then
rebuildQueueSlots()
elseif event == "PLAYER_EQUIPMENT_CHANGED" or event == "PLAYER_ENTERING_WORLD" then
local _, cls = UnitClass("player")
sw.isWarrior = (cls == "WARRIOR")
swingUpdateSpeeds()
if sw.ohSpeed <= 0 then swing.off.active = false end
rebuildQueueSlots()
end
end)
subscribeSpellGoSelf(swingOnSpellGo)
end
-- (active, start, duration, blocked, clipWarning, clipDelay, queuedAbility) or
-- false. blocked/clip/queued are main-hand-only concepts (false/0/"none" else).
function WA.SwingInfo(hand)
local s = swing[hand] or swing.main
if not s.active then return false end
if hand == "main" or hand == nil then
return true, s.start, s.duration, sw.mhBlocked, sw.mhClipWarn, sw.mhClipDelay, WA.SwingQueued()
end
return true, s.start, s.duration, false, false, 0, "none"
end
-- Power-tick watcher: no client event fires on the 2s energy / 5s mana regen
-- tick itself, so it's inferred from power-value increases, the same approach
-- pfUI's energytick module uses. Rage and focus have no regen tick.
local POWER_TICK_INTERVAL = { [0] = 5, [3] = 2 }
local pt = {
active = false, start = 0, duration = 0,
lastPower = 0, powerType = 0, ignoreNextGain = false,
}
local powerTickFrame
local function powerTickResync()
pt.powerType = UnitPowerType("player")
pt.lastPower = UnitMana("player") or 0
if pt.active then
pt.active = false
WA.ScanEvents("WA_POWERTICK_UPDATE")
end
end
local function powerTickOnPowerEvent()
local newPower = UnitMana("player") or 0
local oldPower = pt.lastPower
pt.lastPower = newPower
-- In vanilla a spend does not reset the tick, so a decrease is a no-op.
if newPower < oldPower then return end
-- A buff/proc gain (e.g. Thistle Tea) also raises power but isn't a tick;
-- the combat-log filter below flags the one that follows so it doesn't
-- restart the clock. Consumed on any non-decrease, not just a strict
-- increase, so a gain landing at already-full power doesn't leave the flag
-- to swallow the next real tick.
if pt.ignoreNextGain then
pt.ignoreNextGain = false
return
end
if newPower <= oldPower then return end
local interval = POWER_TICK_INTERVAL[pt.powerType]
local max = UnitManaMax("player") or 0
local full = max > 0 and newPower >= max
if not interval or full then
if pt.active then pt.active = false; WA.ScanEvents("WA_POWERTICK_UPDATE") end
return
end
pt.start = GetTime(); pt.duration = interval; pt.active = true
WA.ScanEvents("WA_POWERTICK_UPDATE")
end
function WA.WatchPowerTick()
if powerTickFrame then return end
powerTickResync()
powerTickFrame = CreateFrame("Frame")
local evs = { "UNIT_MANA", "UNIT_ENERGY", "UNIT_RAGE", "UNIT_DISPLAYPOWER",
"PLAYER_ENTERING_WORLD", "CHAT_MSG_SPELL_SELF_BUFF",
"CHAT_MSG_SPELL_PERIODIC_SELF_BUFFS" }
for i = 1, table.getn(evs) do pcall(powerTickFrame.RegisterEvent, powerTickFrame, evs[i]) end
powerTickFrame:SetScript("OnEvent", function()
if event == "UNIT_DISPLAYPOWER" or event == "PLAYER_ENTERING_WORLD" then
if arg1 and arg1 ~= "player" then return end
powerTickResync()
elseif event == "CHAT_MSG_SPELL_SELF_BUFF" or event == "CHAT_MSG_SPELL_PERIODIC_SELF_BUFFS" then
if arg1 and string.find(arg1, "You gain") and string.find(arg1, "Energy from") then
pt.ignoreNextGain = true
end
else
if arg1 and arg1 ~= "player" then return end
powerTickOnPowerEvent()
end
end)
end
-- (active, start, duration) or false. Rolls the window forward to the current
-- tick boundary if it expired with no power event to advance it (a tick that
-- fired while capped-and-spent, or one the client didn't report).
function WA.PowerTickInfo()
if not pt.active then return false end
local now = GetTime()
if pt.duration > 0 then
while now >= pt.start + pt.duration do
pt.start = pt.start + pt.duration
end
end
return true, pt.start, pt.duration
end
-- ---------------------------------------------------------------------------
-- Event dispatch (§4.3) + the shared game-event frame
-- ---------------------------------------------------------------------------
local eventFrame = CreateFrame("Frame")
local registered = {} -- event -> true, so we RegisterEvent each game event once
local function ensureEventRegistered(event)
if registered[event] or INTERNAL_EVENTS[event] then return end
registered[event] = true
-- Guarded: an invalid event name on this build would otherwise error out the
-- whole Add (risk (c)).
pcall(eventFrame.RegisterEvent, eventFrame, event)
end
-- The per-frame pulse behind `check = "update"`. Its own frame because an
-- OnUpdate on the shared event frame would run for every display in the addon,
-- and because hiding a frame is how an OnUpdate is switched off -- there is no
-- way to unregister one.
local frameUpdateFrame
-- Runs the OnUpdate iff some loaded trigger listens for it. 1.12 hands the
-- handler its elapsed time as the global arg1.
local function syncFrameUpdate()
local map = loaded_events["FRAME_UPDATE"]
local any = false
if map then
for _ in pairs(map) do any = true; break end
end
if not any then
if frameUpdateFrame then frameUpdateFrame:Hide() end
return
end
if not frameUpdateFrame then
frameUpdateFrame = CreateFrame("Frame")
frameUpdateFrame:SetScript("OnUpdate", function()
WA.ScanEvents("FRAME_UPDATE", arg1)
end)
end
frameUpdateFrame:Show()
end
-- Whether this trigger accepts one payload of a unit-filtered event. The filter
-- is the local stand-in for upstream's RegisterUnitEvent: the general event is
-- registered, so an unwanted unit has to be dropped here instead of never
-- arriving. Events the trigger declared no filter for always pass.
local function passesUnitFilter(ti, event, unit)
local filters = ti.unitFilters
local set = filters and filters[event]
if not set then return true end
if unit == nil then return false end
return set[string.lower(tostring(unit))] and true or false
end
-- A trigger asking for FRAME_UPDATE at every frame is affordable only because it
-- can ask for less. Upstream's onUpdateThrottle, in seconds; 0 means every frame.
local function checkOnUpdateThrottle(ti)
local throttle = ti.onUpdateThrottle
if not throttle or throttle <= 0 then return true end
local now = GetTime()
if not ti.lastOnUpdate or (now - ti.lastOnUpdate) >= throttle then
ti.lastOnUpdate = now
return true
end
return false
end
-- watchedTriggers[id][watchedNum][observerNum]: observerNum's "TRIGGER:watchedNum"
-- subscription. Pending/timers hold one coalesced delivery per display.
local watchedTriggers = {}
local watchedPending = {}
local watchedTimers = {}
-- Records one trigger's TRIGGER:n subscriptions, refusing a reciprocal pair.
-- Two triggers watching each other would hand the delivery back and forth
-- forever; upstream drops the second half of the pair, and which half that is
-- falls out of compile order.
local function registerWatchedTriggers(id, observerNum, requested)
local byWatched = watchedTriggers[id]
for num in pairs(requested) do
if num ~= observerNum
and not (byWatched and byWatched[observerNum] and byWatched[observerNum][num]) then
byWatched = byWatched or {}
watchedTriggers[id] = byWatched
byWatched[num] = byWatched[num] or {}
byWatched[num][observerNum] = true
end
end
end
local function cancelWatchedDelivery(id)
if watchedTimers[id] then
watchedTimers[id]:Cancel()
watchedTimers[id] = nil
end
watchedPending[id] = nil
end
-- A fire-and-forget trigger takes itself down on a timer instead of on a later
-- event. C_Timer.NewTimer, not After: After returns nothing on this client, and
-- a re-fire before the deadline must retract the pending hide or the second show
-- gets cut short by the first one's timer.
local function scheduleAutoHide(ti, cloneId)
cloneId = cloneId or ""
ti.hideTimers = ti.hideTimers or {}
local old = ti.hideTimers[cloneId]
if old then old:Cancel() end
local timer
local function hideState()
if not ti.hideTimers or ti.hideTimers[cloneId] ~= timer then return end
ti.hideTimers[cloneId] = nil
local states = WA.GetTriggerStateForTrigger(ti.id, ti.triggernum)
local s = states and states[cloneId]
if s and s.show then
s.show = false; s.changed = true
WA.UpdatedTriggerState(ti.id)
end
end
timer = C_Timer.NewTimer(ti.duration, hideState)
ti.hideTimers[cloneId] = timer
end
-- ActivateEvent-lite (§4.3): after a passing test, normalize the state's
-- progress/name/icon. Stores already wrote the raw matched fields; this fills
-- the display-shaped fields regions read.
local function activateEvent(state, ti, cloneId)
local proto = ti.proto
if not state.show then state.show = true; state.changed = true end
local function setC(k, v)
if state[k] ~= v then state[k] = v; state.changed = true end
end
if ti.autoHide then
-- Its progress is the countdown to its own hide timer, not anything the
-- prototype stores, and every re-fire restarts both together.
setC("progressType", "timed")
setC("duration", ti.duration)
setC("expirationTime", GetTime() + ti.duration)
scheduleAutoHide(ti, cloneId)
elseif ti.customDurationFunc then
local ok, values = WA.RunAuraFuncPacked(ti.id, ti.id .. ": duration function",
ti.customDurationFunc, ti.trigger)
local first = ok and tonumber(values[1]) or 0
local second = ok and tonumber(values[2]) or 0
setC("inverse", ok and values[4] or nil)
if ok and values[3] then
setC("progressType", "static")
setC("value", first)
setC("total", second)
setC("duration", nil)
setC("expirationTime", nil)
else
if second <= first then second = first end
setC("progressType", "timed")
setC("duration", first)
setC("expirationTime", second)
setC("value", nil)
setC("total", nil)
end
else
-- ti.* overrides let a per-trigger prototype (the custom trigger) pick its
-- progress shape at Add time; built-in prototypes leave them nil and fall back
-- to the static proto fields.
local progressType = ti.progressType or proto.progressType
local progressValue = ti.progressValue or proto.progressValue
local progressTotal = ti.progressTotal or proto.progressTotal
if progressType == "timed" then
setC("progressType", "timed")
elseif progressType == "static" then
setC("progressType", nil)
setC("value", state[progressValue] or 0)
setC("total", state[progressTotal] or 0)
else
setC("progressType", nil)
end
end
-- ti.name/ti.icon are compile-time constants (nameFunc/iconFunc run once at
-- Add). A prototype that stores a live `name`/`icon` field (e.g. health/power
-- reading UnitName each tick) has already written state; only fall back to the
-- constant when it didn't -- which also keeps a target-unit's display name live
-- instead of frozen at the target present when the aura was compiled.
if ti.name ~= nil and state.name == nil then setC("name", ti.name) end
if ti.icon ~= nil and state.icon == nil then setC("icon", ti.icon) end
if ti.customNameFunc then
local ok, value = WA.RunAuraFunc(ti.id, ti.id .. ": name function",
ti.customNameFunc, ti.trigger)
if ok then setC("name", value) end
end
if ti.customIconFunc then
local ok, value = WA.RunAuraFunc(ti.id, ti.id .. ": icon function",
ti.customIconFunc, ti.trigger)
if ok then setC("icon", value) end
end
end
-- One member of a multi-unit family: created, refreshed, or dropped in place.
local function runMultiUnitMember(ti, states, event, unit, cloneId)
local state = states[cloneId]
local existed = state ~= nil
if not state then state = {} end
local ok, passed = WA.RunAuraFunc(ti.id, ti.id, ti.triggerFunc, state, event, unit)
if ok and passed then
if not existed then
states[cloneId] = state
state.changed = true
end
activateEvent(state, ti, cloneId)
return state.changed and true or false
elseif existed then
states[cloneId] = nil
return true
end
return false
end
-- Every current member re-read, and every state whose member is gone dropped.
local function runMultiUnitFullPass(ti, states, event)
local seen = {}
local dirty = false
WA.ForEachMultiUnit(ti.multiUnit, function(unit, cloneId)
seen[cloneId] = true
if runMultiUnitMember(ti, states, event, unit, cloneId) then dirty = true end
end)
local stale = {}
for cloneId in pairs(states) do
if cloneId ~= "" and not seen[cloneId] then table.insert(stale, cloneId) end
end
for i = 1, table.getn(stale) do
states[stale[i]] = nil
dirty = true
end
return dirty
end
-- Which event means a member left for good. A leaving plate's token still
-- resolves to its unit for the duration of the handler (ClassicAPI computes the
-- token before the slot vacates), so rescanning the family here would re-create
-- the clone that just went away -- its state has to be dropped by GUID instead.
local MULTI_UNIT_REMOVE_EVENT = { nameplate = "NAME_PLATE_UNIT_REMOVED" }
-- Routes one event to the family: a removal drops one state, a unit event
-- re-reads only the member it names, and anything else (roster churn, forced
-- initialization) re-reads the whole family and sweeps what is no longer in it.
local function runMultiUnitTrigger(ti, event, unit)
local states = WA.GetTriggerStateForTrigger(ti.id, ti.triggernum)
if not states then return false end
local family = ti.multiUnit
if event == MULTI_UNIT_REMOVE_EVENT[family] then
local cloneId = type(unit) == "string" and WA.UnitCloneId(unit) or nil
if cloneId and states[cloneId] ~= nil then
states[cloneId] = nil
return true
end
return false
end
if type(unit) == "string" and UnitExists(unit) then
local cloneId = WA.UnitCloneId(unit)
local state = cloneId and states[cloneId]
-- One unit is reachable through several tokens at once (the player in a
-- raid is also raid7, and maybe target), and ClassicAPI fires the unit
-- event once per token. The state keeps the token its own family
-- iterates rather than adopting whichever token woke it.
if state then return runMultiUnitMember(ti, states, event, state.unit or unit, cloneId) end
if WA.MultiUnitHasToken(family, unit) then
return runMultiUnitMember(ti, states, event, unit, cloneId)
end
return false
end
return runMultiUnitFullPass(ti, states, event)
end
-- Runs a Trigger State Updater over its whole allstates table (upstream's `full`
-- statesParameter, §4.3): the custom function owns every clone key and reports
-- either by returning truthy or through the helper methods. Nothing here shapes
-- the states afterwards -- a TSU state supplies its own progress, name and icon,
-- which is the difference between this and activateEvent's normalization.
local function runTsuTrigger(ti, event, a1, a2, a3, a4, a5, a6, a7, a8, a9)
local states = WA.GetTriggerStateForTrigger(ti.id, ti.triggernum)
if not states then return false end
-- Per run, not once at compile: WA.Add builds a fresh allstates table on every
-- recompile, so the helpers have to be re-attached to whatever table is live.
WA.EnsureAllStates(states, ti.showNilIsFalse)
states:SetChanged(false)
local ok, returned = WA.RunAuraFunc(ti.id, ti.id, ti.triggerFunc, states, event,
a1, a2, a3, a4, a5, a6, a7, a8, a9)
local dirty = (ok and (returned or (returned ~= false and states:IsChanged()))) and true or false
states:SetChanged(false)
-- Every consumer downstream indexes a clone key expecting a state table. One
-- non-table poisons the whole trigger rather than one clone, so upstream drops
-- the table entirely instead of guessing which key the author meant.
local bad
for key, state in pairs(states) do
if type(state) ~= "table" then bad = key; break end
end
if bad then
DEFAULT_CHAT_FRAME:AddMessage("|cffff0000WeakestAuras|r [" .. ti.id
.. "] all states table contains a non-table at key: " .. tostring(bad), 1, 0.3, 0.3)
local keys = {}
for key in pairs(states) do table.insert(keys, key) end
for i = 1, table.getn(keys) do states[keys[i]] = nil end
WA.StopStateTimers(ti.id, ti.triggernum)
return true
end
if ti.showNilIsFalse then
for _, state in pairs(states) do
if state.show == nil then state.show = false end
end
end
WA.StartStopStateTimers(ti.id, ti.triggernum, states)
return dirty
end
-- Runs one trigger's compiled function for an event and reconciles its base
-- state or one new event clone.
-- Returns true if the state changed (so the caller batches UpdatedTriggerState).
local function runTriggerFunc(ti, event, a1, a2, a3, a4, a5, a6, a7, a8, a9)
if ti.tsu then return runTsuTrigger(ti, event, a1, a2, a3, a4, a5, a6, a7, a8, a9) end
if ti.multiUnit then return runMultiUnitTrigger(ti, event, a1) end
local states = WA.GetTriggerStateForTrigger(ti.id, ti.triggernum)
if not states then return false end
local cloneId = ""
local state
if ti.useCloneId then
state = {}
else
state = states[""]
if not state then state = {}; states[""] = state end
end
-- state.changed is false on entry (UpdatedTriggerState clears it after every
-- batch, step 7), so the flag the compiled stores / activateEvent set is a
-- true "changed since last apply" signal.
local ok, passed
if ti.custom and not ti.legacyStateArgs then
ok, passed = WA.RunAuraFunc(ti.id, ti.id, ti.triggerFunc, event,
a1, a2, a3, a4, a5, a6, a7, a8, a9)
else
ok, passed = WA.RunAuraFunc(ti.id, ti.id, ti.triggerFunc, state, event,
a1, a2, a3, a4, a5, a6, a7, a8, a9)
end
if ok and passed then
if ti.useCloneId then
cloneId = WA.GetUniqueCloneId(states)
if cloneId == nil then return false end
states[cloneId] = state
end
activateEvent(state, ti, cloneId)
elseif ok and ti.untriggerFunc then
local untriggerOk, shouldHide
if ti.legacyStateArgs then
untriggerOk, shouldHide = WA.RunAuraFunc(ti.id, ti.id .. ": untrigger",
ti.untriggerFunc, state, event, a1, a2, a3, a4, a5, a6, a7, a8, a9)
else
untriggerOk, shouldHide = WA.RunAuraFunc(ti.id, ti.id .. ": untrigger",
ti.untriggerFunc, event, a1, a2, a3, a4, a5, a6, a7, a8, a9)
end
if untriggerOk and shouldHide and state.show then
state.show = false; state.changed = true
end
elseif state.show and not ti.autoHide and not ti.eventMode then
-- Event states end through their declared hide path. A status state follows
-- its test result directly.
state.show = false; state.changed = true
end
return state.changed and true or false
end
-- Delivers the coalesced TRIGGER:n updates one display accumulated, as
-- ("TRIGGER", watchedTriggernum, thatTrigger'sStates).
local function flushWatchedTriggers(id)
watchedTimers[id] = nil
local pending = watchedPending[id]
watchedPending[id] = nil
local byWatched = watchedTriggers[id]
local byTrigger = events[id]
if not pending or not byWatched or not byTrigger or WA.forced[id] then return end
local dirty = false
for watchedNum in pairs(pending) do
local observers = byWatched[watchedNum]
local updated = WA.GetTriggerStateForTrigger(id, watchedNum)
if observers and updated then
for observerNum in pairs(observers) do
local ti = byTrigger[observerNum]
if ti and runTriggerFunc(ti, "TRIGGER", watchedNum, updated) then
dirty = true
-- An observer that changed is itself worth watching, so a chain
-- of TRIGGER:n subscriptions carries one hop per delivery. The
-- timer for the next hop is scheduled fresh, this one having
-- already released its slot above.
WA.NotifyWatchedTriggers(id, observerNum)
end
end
end
end
if dirty then WA.UpdatedTriggerState(id) end
end
-- One of a display's triggers produced new states; anything watching it hears so
-- on a zero-delay timer rather than inline. The delay is the recursion guard that
-- matters: a watcher runs after the state pass that woke it has finished, so it
-- cannot re-enter it, and several updates in one pass collapse into one delivery.
-- Called by the state-owned hide timers as well as by dispatch.
function WA.NotifyWatchedTriggers(id, triggernum)
local byWatched = watchedTriggers[id]
if not byWatched or not byWatched[triggernum] then return end
watchedPending[id] = watchedPending[id] or {}
watchedPending[id][triggernum] = true
if watchedTimers[id] then return end
watchedTimers[id] = C_Timer.NewTimer(0, function() flushWatchedTriggers(id) end)
end
-- The producer entry point watchers and the event frame both call (§4.3):
-- walk every trigger registered for `event`, run it, batch one
-- UpdatedTriggerState per affected display.
function WA.ScanEvents(event, a1, a2, a3, a4, a5, a6, a7, a8, a9)
local byId = loaded_events[event]
if not byId then return end
local dirty = {}
for id, byTrigger in pairs(byId) do
for triggernum, ti in pairs(byTrigger) do
if not WA.forced[id] and passesUnitFilter(ti, event, a1)
and (event ~= "FRAME_UPDATE" or checkOnUpdateThrottle(ti)) then
if runTriggerFunc(ti, event, a1, a2, a3, a4, a5, a6, a7, a8, a9) then
dirty[id] = true
WA.NotifyWatchedTriggers(id, triggernum)
end
end
end
end
for id in pairs(dirty) do WA.UpdatedTriggerState(id) end
end
-- A handler on this client reads the event payload off the globals arg1..arg9,
-- which exist only for the duration of the handler -- so they are read here and
-- passed explicitly rather than left for ScanEvents to pick up.
eventFrame:SetScript("OnEvent", function()
if event == "PLAYER_ENTERING_WORLD" then
C_Timer.After(1, function() WA.ScanEvents("WA_DELAYED_PLAYER_ENTERING_WORLD") end)
end
WA.ScanEvents(event, arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9)
end)
-- PLAYER_ENTERING_WORLD is the source for the delayed status refresh, so it
-- must be observed even when no active prototype lists the native event.
ensureEventRegistered("PLAYER_ENTERING_WORLD")
-- ---------------------------------------------------------------------------
-- Trigger-system contract (StateMachine.lua calls these)
-- ---------------------------------------------------------------------------
-- Pulls a display's tis out of loaded_events (it stops receiving events) but
-- leaves events[id] intact -- Unload uses this, Delete drops events[id] after.
local function unregisterEvents(id)
local byTrigger = events[id]
if not byTrigger then return end
-- Pending state-owned hides and watched-trigger deliveries, on the same
-- grounds as the per-trigger hide timers below.
cancelWatchedDelivery(id)
WA.StopStateTimers(id)
for triggernum, ti in pairs(byTrigger) do
-- A pending hide outlives the events that scheduled it, and would fire
-- against a display that has since unloaded or been recompiled.
if ti.hideTimers then
for _, timer in pairs(ti.hideTimers) do
if timer then timer:Cancel() end
end
ti.hideTimers = nil
end
local evs = ti.eventList or {}
for i = 1, table.getn(evs) do
local map = loaded_events[evs[i]]
if map and map[id] then map[id][triggernum] = nil end
end
end
-- Drop now-empty per-event maps so ScanEvents doesn't walk dead ids.
for event, map in pairs(loaded_events) do
if map[id] then
local any = false
for _ in pairs(map[id]) do any = true; break end
if not any then map[id] = nil end
end
end
syncFrameUpdate()
end
-- Compile only: build each triggernum into a ti stored in events[id]. Neither
-- registers into loaded_events nor force-initializes status triggers -- both
-- wait for LoadDisplays (§11), so an unloaded display costs no events.
function GenericTrigger.Add(data)
-- Kept across the Delete below so a trigger whose compiled source is
-- unchanged can be told from one that was edited: the second is a seam for
-- dropping whatever the old code cached in aura_env, and WA.Add is not --
-- it fires per drag step.
local prev = events[data.id] or lastCompiled[data.id]
GenericTrigger.Delete(data.id)
local byTrigger = {}
events[data.id] = byTrigger
unresolvedIds[data.id] = nil
compilingId = data.id
for triggernum = 1, table.getn(data.triggers) do
local trigger = WA.GetTrigger(data, triggernum)
local proto = trigger and PROTOTYPES[trigger.type]
if proto then
local fn, source, sourceKey, untriggerFunc, customDurationFunc, customNameFunc, customIconFunc
local tsuVariablesFunc, customEvents, customUnitFilters, customWatched
local errTag = data.id .. ": trigger " .. triggernum
local isTsu = proto.custom and trigger.custom_type == "stateupdate"
if proto.custom then
fn, source = constructCustomFunction(trigger, errTag)
local entry = data.triggers[triggernum]
local untriggerSource = entry.untrigger and entry.untrigger.custom or ""
if isTsu then
-- TSU state carries its own progress, name, icon and hiding, so the
-- auxiliary functions are not compiled at all rather than compiled
-- and left unread -- two sources for one value is what the editor
-- hides in this mode.
untriggerSource = ""
tsuVariablesFunc = compileTsuVariables(trigger.customVariables,
data.id .. ": custom variables " .. triggernum)
else
if trigger.custom_type == "status"
or (trigger.custom_type == "event" and trigger.custom_hide == "custom") then
untriggerFunc = compileCustomField(untriggerSource,
data.id .. ": untrigger " .. triggernum) or trueFunction
end
if trigger.custom_type ~= "event" or trigger.custom_hide == "custom" then
customDurationFunc = compileCustomField(trigger.customDuration,
data.id .. ": duration function " .. triggernum)
end
customNameFunc = compileCustomField(trigger.customName,
data.id .. ": name function " .. triggernum)
customIconFunc = compileCustomField(trigger.customIcon,
data.id .. ": icon function " .. triggernum)
end
if (trigger.custom_type == "status" or isTsu) and trigger.check == "update" then
customEvents = { "FRAME_UPDATE" }
else
customEvents, customUnitFilters, customWatched = parseCustomEventList(trigger.events)
end
if customWatched then
registerWatchedTriggers(data.id, triggernum, customWatched)
end
sourceKey = table.concat({ source or "", untriggerSource,
trigger.customDuration or "", trigger.customName or "", trigger.customIcon or "",
trigger.customVariables or "" }, "\n")
else
fn, source = constructFunction(proto, trigger, errTag)
end
sourceKey = sourceKey or source
local prevTi = prev and prev[triggernum]
if not prevTi or (prevTi.sourceKey or prevTi.source) ~= sourceKey then
WA.ClearAuraEnv(data.id)
end
if fn then
local ti = {
id = data.id, triggernum = triggernum, proto = proto,
trigger = trigger, triggerFunc = fn, source = source, sourceKey = sourceKey,
eventMode = (proto.eventMode or (proto.custom and trigger.custom_type == "event")) and true or false,
useCloneId = (trigger.type == "chatmessage" and trigger.use_cloneId) and true or false,
multiUnit = proto.statesParameter == "unit" and multiUnitFamily(trigger) or nil,
eventList = customEvents or proto.events(trigger),
name = proto.nameFunc and proto.nameFunc(trigger) or nil,
icon = proto.iconFunc and proto.iconFunc(trigger) or proto.icon,
forceEvents = proto.force_events and not (proto.custom and trigger.custom_type == "event"),
}
if proto.custom then
ti.custom = true
ti.unitFilters = customUnitFilters
ti.onUpdateThrottle = tonumber(trigger.onUpdateThrottle) or 0
ti.legacyStateArgs = trigger.weakestAurasLegacyStateArgs and true or false
if isTsu then
ti.tsu = true
ti.tsuVariablesFunc = tsuVariablesFunc
-- Upstream's saved flag for the contract where a state the code
-- built without setting `show` is hidden rather than left
-- undecided. An import predating the flag does not carry it and
-- keeps the older reading; the editor stamps it on an aura that
-- picks this mode with no `information` of its own.
ti.showNilIsFalse = (data.information and data.information.showNilIsFalse) and true or false
else
ti.untriggerFunc = untriggerFunc
ti.customDurationFunc = customDurationFunc
ti.customNameFunc = customNameFunc
ti.customIconFunc = customIconFunc
ti.progressType = trigger.customProgressType or "none"
ti.progressValue = "value"
ti.progressTotal = "total"
if trigger.custom_type == "event" and trigger.custom_hide == "timed" then
ti.autoHide = true
ti.duration = tonumber(trigger.duration) or 1
end
end
end
if proto.autoHide then
ti.autoHide = true
ti.duration = tonumber(trigger.duration) or 1
end
byTrigger[triggernum] = ti
end
end
end
compilingId = nil
end
-- Load: register this display's tis into loaded_events (+ RegisterEvent their
-- game events), fire watcher loadFuncs, then force-initialize status triggers
-- (§4.3 force_events) and recombine once. Only touches ids this system
-- compiled (events[id]).
function GenericTrigger.LoadDisplays(ids)
for k = 1, table.getn(ids) do
local id = ids[k]
local byTrigger = events[id]
if byTrigger and not activeIds[id] then
activeIds[id] = true
local toForce = {}
for triggernum, ti in pairs(byTrigger) do
for i = 1, table.getn(ti.eventList) do
local ev = ti.eventList[i]
ensureEventRegistered(ev)
loaded_events[ev] = loaded_events[ev] or {}
loaded_events[ev][id] = loaded_events[ev][id] or {}
loaded_events[ev][id][triggernum] = ti
end
-- loadFunc (e.g. WatchSpellCooldown) is a "start watching" side
-- effect, so it belongs to load, not compile -- an unloaded
-- cooldown aura shouldn't spin up its watcher.
if ti.proto.loadFunc then ti.proto.loadFunc(ti.trigger) end
if ti.forceEvents then table.insert(toForce, ti) end
end
if table.getn(toForce) > 0 then
for i = 1, table.getn(toForce) do
local ti = toForce[i]
if runTriggerFunc(ti, ti.tsu and "STATUS" or "FORCE") then
WA.NotifyWatchedTriggers(id, ti.triggernum)
end
end
WA.UpdatedTriggerState(id)
end
end
end
syncFrameUpdate()
end
-- Re-seed an already-loaded display's status triggers (WA2's
-- ScanWithFakeEvent): same force_events pass LoadDisplays runs, for callers that
-- wiped the produced states without a load transition -- the options preview
-- retiring its fake, which otherwise leaves a still-true status trigger reading
-- as inactive until its next real event.
function GenericTrigger.ForceUpdate(ids)
for k = 1, table.getn(ids) do
local id = ids[k]
local byTrigger = events[id]
if byTrigger and activeIds[id] then
local dirty = false
for triggernum, ti in pairs(byTrigger) do
if ti.forceEvents then
if runTriggerFunc(ti, ti.tsu and "STATUS" or "FORCE") then
dirty = true
WA.NotifyWatchedTriggers(id, triggernum)
end
end
end
if dirty then WA.UpdatedTriggerState(id) end
end
end
end
-- Unload: pull the display's tis from loaded_events, keeping events[id] so a
-- reload re-registers without recompiling.
function GenericTrigger.UnloadDisplays(ids)
for k = 1, table.getn(ids) do
local id = ids[k]
if activeIds[id] then
activeIds[id] = nil
unregisterEvents(id)
end
end
end
function GenericTrigger.Delete(id)
GenericTrigger.UnloadDisplays({ id })
-- Handed to the next Add so it can still tell an edited trigger from an
-- untouched one. WA.Add deletes every system before it re-adds them, so by
-- the time Add runs, events[id] is already gone and the comparison it makes
-- would otherwise always report "changed" -- which drops aura_env on every
-- recompile, including the ones WA.Add fires per drag step.
if events[id] then lastCompiled[id] = events[id] end
events[id] = nil
-- Rebuilt from scratch by the next Add, which is also what makes the
-- reciprocal-watch refusal depend only on this compile's own order.
watchedTriggers[id] = nil
unresolvedIds[id] = nil
cancelWatchedDelivery(id)
WA.StopStateTimers(id)
end
function GenericTrigger.Rename(oldId, newId)
local byTrigger = events[oldId]
if not byTrigger then return end
for triggernum, ti in pairs(byTrigger) do
ti.id = newId
local evs = ti.eventList or {}
for i = 1, table.getn(evs) do
local map = loaded_events[evs[i]]
if map and map[oldId] then
map[newId] = map[oldId]
map[oldId] = nil
end
end
end
events[newId] = byTrigger
events[oldId] = nil
lastCompiled[oldId] = nil
if unresolvedIds[oldId] then
unresolvedIds[newId] = true
unresolvedIds[oldId] = nil
end
if activeIds[oldId] then
activeIds[newId] = true
activeIds[oldId] = nil
end
if watchedTriggers[oldId] then
watchedTriggers[newId] = watchedTriggers[oldId]
watchedTriggers[oldId] = nil
end
cancelWatchedDelivery(oldId)
WA.RenameStateTimers(oldId, newId)
end
function GenericTrigger.CreateFallbackState(data, triggernum, state)
local trigger = WA.GetTrigger(data, triggernum)
local proto = trigger and PROTOTYPES[trigger.type]
if proto then
state.name = proto.nameFunc and proto.nameFunc(trigger) or proto.displayName
state.icon = proto.iconFunc and proto.iconFunc(trigger) or proto.icon
if proto.progressType == "timed" then state.progressType = "timed" end
end
state.active = false
return state
end
function GenericTrigger.GetNameAndIcon(data, triggernum)
local trigger = WA.GetTrigger(data, triggernum)
local proto = trigger and PROTOTYPES[trigger.type]
if not proto then return nil, nil end
local name = proto.nameFunc and proto.nameFunc(trigger) or proto.displayName
local icon = proto.iconFunc and proto.iconFunc(trigger) or proto.icon
return name, icon
end
-- The variables a Trigger State Updater declares, read out of its compiled
-- customVariables chunk. That chunk is user code, so it runs through the aura
-- environment; a chunk that errors or returns a non-table declares nothing.
-- Public because it is the same answer the editor reports validation against.
function WA.GetTsuVariables(id, triggernum)
local byTrigger = events[id]
local ti = byTrigger and byTrigger[triggernum]
if not ti or not ti.tsuVariablesFunc then return nil end
local ok, variables = WA.RunAuraFunc(id, id .. ": custom variables " .. triggernum,
ti.tsuVariablesFunc)
if not ok then return nil end
return variables
end
-- Condition variables (§10): every store arg that declared a conditionType.
function GenericTrigger.GetTriggerConditions(data, triggernum)
local trigger = WA.GetTrigger(data, triggernum)
local proto = trigger and PROTOTYPES[trigger.type]
if not proto then return {} end
-- A TSU declares its own; the prototype has no args to derive them from.
if proto.custom and trigger.custom_type == "stateupdate" then
return WA.CleanCustomVariables(WA.GetTsuVariables(data.id, triggernum)) or {}
end
local out = {}
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
if arg.conditionType then
out[arg.name] = { display = arg.display or arg.name, type = arg.conditionType,
values = arg.valueLabels }
end
end
return out
end
-- Debug read-only accessor (Debug.lua's /wa gen): the generated source for
-- trigger 1 of this display.
function WA.GetGeneratedSource(id)
local byTrigger = events[id]
if not byTrigger then return nil end
local ti = byTrigger[1]
for _, t in pairs(byTrigger) do ti = ti or t end
return ti and ti.source
end
-- Debug read-only accessor (Debug.lua's /wa load): whether this system
-- actually finished registering id into loaded_events, independent of
-- StateMachine's own `loaded[id]` flag -- that flag is set true before
-- applyLoad hands off to each system's LoadDisplays (see StateMachine.lua),
-- so it can say "loaded" even when a system's registration silently never
-- happened. true/false only meaningful for an id this system compiled
-- (events[id] non-nil); nil otherwise.
function WA.IsGenericTriggerActive(id)
if not events[id] then return nil end
return activeIds[id] and true or false
end
-- ---------------------------------------------------------------------------
-- Options-side registration: one trigger *type* per prototype, its editor
-- generated from the same args (§4.1). The runtime layer is this one
-- GenericTrigger system, registered for all of them.
-- ---------------------------------------------------------------------------
local function buildDefaults(proto)
local d = {}
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
if arg.type == "unit" then
d[arg.name] = arg.default or "player"
d.specificUnit = ""
elseif arg.type == "range" then
d[arg.name] = arg.default or 0
elseif arg.type == "string" then
if not arg.required then d["use_" .. arg.name] = false end
d[arg.name .. "_operator"] = arg.operator or "=="
d[arg.name] = arg.default or ""
elseif arg.type == "spell" or arg.type == "item" or arg.type == "talent" or arg.type == "text" then
d[arg.name] = arg.default or ""
elseif arg.type == "toggle" then
d[arg.name] = arg.default or false
elseif arg.type == "select" and arg.required then
local values = type(arg.valueList) == "function" and arg.valueList(d) or arg.valueList
d[arg.name] = arg.default or (values and values[1])
elseif arg.type == "select" and not arg.required then
d["use_" .. arg.name] = false
local values = type(arg.valueList) == "function" and arg.valueList(d) or arg.valueList
d[arg.name] = arg.default or (values and values[1])
elseif arg.type == "number" and not arg.required then
d["use_" .. arg.name] = false
d[arg.name .. "_operator"] = arg.operator or ">="
d[arg.name] = arg.default or 0
if arg.multiEntry then
d["use_" .. arg.name .. "2"] = false
d[arg.name .. "2_operator"] = arg.operator2 or "<="
d[arg.name .. "2"] = arg.default2 or 0
end
end
end
if proto.defaults then
for k, v in pairs(proto.defaults) do d[k] = v end
end
return d
end
local function buildOptions(data, triggernum)
local t = WA.GetTrigger(data, triggernum or 1)
local proto = t and PROTOTYPES[t.type]
if not proto then return WA.TriggerTypeFields(data, t) end
if proto.custom then
local fields = WA.TriggerTypeFields(data, t)
local entry = data.triggers[triggernum or 1]
entry.untrigger = entry.untrigger or {}
local function validate(txt, label)
return WA.Widgets.LuaSyntaxError(WA.WrapFunctionSource(txt), label)
end
local optionKey = tostring(data.id or "") .. ":" .. tostring(triggernum or 1)
local search = customEventSearch[optionKey] or ""
local eventValues, eventLabels = eventPickerValues(search)
local isTsu = t.custom_type == "stateupdate"
local perFrame = isTsu and t.check == "update"
local more = {
{ type = "header", name = "Custom Trigger" },
{ type = "select", name = "Event Type", key = "custom_type",
values = { "status", "event", "stateupdate" },
labels = { status = "Status", event = "Event",
stateupdate = "Trigger State Updater (Advanced)" },
get = function() return t.custom_type or "status" end,
set = function(v)
t.custom_type = v
if v ~= "status" then t.weakestAurasLegacyStateArgs = nil end
-- Upstream stamps this on every aura it creates, and a TSU state
-- that never set `show` reads differently with and without it. An
-- aura that arrived carrying `information` keeps whatever it said.
if v == "stateupdate" and data.information == nil then
data.information = { showNilIsFalse = true }
end
WA.Add(data); WA.RefreshOptions()
end },
}
if isTsu then
table.insert(more, { type = "select", name = "Check On", key = "check",
values = { "event", "update" },
labels = { event = "Event(s)", update = "Every Frame" },
get = function() return t.check or "event" end,
set = function(v) t.check = v; WA.Add(data); WA.RefreshOptions() end })
end
if not perFrame then
table.insert(more, { type = "multiline", name = "Event(s)", key = "events", height = 72,
get = function() return t.events or "" end,
set = function(v) t.events = v; WA.Add(data); WA.RefreshOptions() end })
table.insert(more, { type = "description", name =
"Type event names manually above, separated by spaces or commas. "
.. "Or search below, press Enter, and choose Insert Event." })
if isTsu then
table.insert(more, { type = "description", name =
"UNIT_AURA:player:target fires only for the listed units. TRIGGER:2 "
.. "runs this trigger when trigger 2 updates. CLEU: is not available "
.. "on this client." })
end
local invalid = invalidEventList(t.events)
if table.getn(invalid) > 0 then
table.insert(more, { type = "description", name =
"|cffff5555Not registered by this client: " .. table.concat(invalid, ", ")
.. ".|r The names remain saved for addon-generated events." })
end
table.insert(more, { type = "input", name = "Find Event", half = true,
get = function() return customEventSearch[optionKey] or "" end,
set = function(v) customEventSearch[optionKey] = v or ""; WA.RefreshOptions() end })
table.insert(more, { type = "menu", name = "Insert Event", half = true,
values = eventValues, labels = eventLabels,
onSelect = function(v)
if v == "__NO_EVENT_MATCH__" then return end
t.events = appendEventName(t.events, v)
WA.Add(data); WA.RefreshOptions()
end })
end
if perFrame or (isTsu and t.events and string.find(t.events, "FRAME_UPDATE", 1, true)) then
table.insert(more, { type = "range", name = "Throttle (s)", key = "onUpdateThrottle",
min = 0, max = 1, step = 0.01, decimals = 2,
get = function() return tonumber(t.onUpdateThrottle) or 0 end,
set = function(v) t.onUpdateThrottle = v; WA.Add(data) end })
end
table.insert(more, { type = "code", name = "Custom Trigger", key = "custom", height = 180,
get = function() return t.custom end,
set = function(v) t.custom = v; WA.Add(data) end,
default = (isTsu and "function(allstates, event, ...)\n return true\nend")
or (t.weakestAurasLegacyStateArgs
and "function(state, event, ...)\n return true\nend")
or (proto.defaults and proto.defaults.custom),
validate = function(txt) return validate(txt, "custom trigger") end })
if isTsu then
table.insert(more, { type = "code", name = "Custom Variables", key = "customVariables", height = 140,
get = function() return t.customVariables or "" end,
set = function(v) t.customVariables = v; WA.Add(data); WA.RefreshOptions() end,
default = "{\n stacks = \"number\",\n}",
validate = function(txt)
return WA.Widgets.LuaSyntaxError(
WA.WrapFunctionSource("function() return \n" .. (txt or "") .. "\n end"),
"custom variables")
end })
-- The syntax check above only proves the chunk compiles. What the table
-- *says* is checked by running it, which is too much to do per keystroke,
-- so the declaration's own problems are reported off the compiled trigger.
local declared = WA.GetTsuVariables(data.id, triggernum or 1)
local problem = declared ~= nil and WA.ValidateCustomVariables(declared) or nil
if problem then
table.insert(more, { type = "description",
name = "|cffff5555Custom Variables: " .. problem .. "|r" })
end
table.insert(more, { type = "description", name =
"State fields shown here: show, changed, progressType, value, total, "
.. "duration, expirationTime, autoHide, paused, remaining, name, icon, "
.. "stacks, index, inverse." })
table.insert(more, { type = "description", name =
"This code also runs once when the aura loads, with event = \"STATUS\" "
.. "and no payload, so it can seed itself from the current world. Check "
.. "`event` before building state from an argument the load pass has no "
.. "value for." })
end
if t.weakestAurasLegacyStateArgs then
table.insert(more, { type = "select", name = "Legacy Progress", key = "customProgressType",
values = { "none", "timed", "static" },
labels = { none = "None", timed = "Timed", static = "Static" },
get = function() return t.customProgressType or "none" end,
set = function(v) t.customProgressType = v; WA.Add(data) end })
end
if t.custom_type == "event" then
table.insert(more, { type = "select", name = "Hide", key = "custom_hide",
values = { "timed", "custom" }, labels = { timed = "Timed", custom = "Custom" },
get = function() return t.custom_hide or "timed" end,
set = function(v) t.custom_hide = v; WA.Add(data); WA.RefreshOptions() end })
if t.custom_hide ~= "custom" then
table.insert(more, { type = "range", name = "Duration (s)", key = "duration",
min = 0.1, max = 60, step = 0.1,
get = function() return tonumber(t.duration) or 1 end,
set = function(v) t.duration = v; WA.Add(data) end })
end
end
-- Everything below is a second source for a value TSU state already carries,
-- so this mode shows none of it. The saved fields survive untouched, and a
-- trigger switched back out of TSU gets its editors back with its text.
if not isTsu then
if t.custom_type == "status" or t.custom_hide == "custom" then
table.insert(more, { type = "code", name = "Custom Untrigger", key = "customUntrigger", height = 140,
get = function() return entry.untrigger.custom end,
set = function(v) entry.untrigger.custom = v; WA.Add(data) end,
default = t.weakestAurasLegacyStateArgs
and "function(state, event, ...)\n return true\nend"
or "function(event, ...)\n return true\nend",
validate = function(txt) return validate(txt, "custom untrigger") end })
table.insert(more, { type = "code", name = "Duration Info", key = "customDuration", height = 140,
get = function() return t.customDuration or "" end,
set = function(v) t.customDuration = v; WA.Add(data) end,
validate = function(txt) return validate(txt, "duration info") end })
end
table.insert(more, { type = "code", name = "Name Info", key = "customName", height = 120,
get = function() return t.customName or "" end,
set = function(v) t.customName = v; WA.Add(data) end,
validate = function(txt) return validate(txt, "name info") end })
table.insert(more, { type = "code", name = "Icon Info", key = "customIcon", height = 120,
get = function() return t.customIcon or "" end,
set = function(v) t.customIcon = v; WA.Add(data) end,
validate = function(txt) return validate(txt, "icon info") end })
end
for i = 1, table.getn(more) do table.insert(fields, more[i]) end
return fields
end
local fields = WA.TriggerTypeFields(data, t)
for i = 1, table.getn(proto.args) do
local arg = proto.args[i]
-- An arg whose enable() is false is inapplicable to the trigger's selected
-- mode (a spell field while the range mode is "interact"): its control is
-- omitted rather than rendered as a field nothing reads. Visibility only --
-- the stored value and the arg's test are untouched, so an arg that goes
-- back into view keeps what it had.
if arg.enable and not arg.enable(t) then
-- inapplicable to this configuration
elseif arg.hidden or arg.type == "hidden" then
-- computed/stored only, no UI
elseif arg.type == "header" then
table.insert(fields, { type = "header", name = arg.display or "" })
elseif arg.type == "unit" then
-- The dropdown's "specific" entry swaps in a free-text token field
-- beside it; the dropdown's stored token survives being hidden and
-- comes back when the override is switched off.
table.insert(fields, {
type = "select", name = arg.display or "Unit", key = arg.name, half = true,
values = arg.valueList or WA.unit_tokens,
labels = arg.valueLabels or WA.unit_labels,
get = function() return t[arg.name] end,
set = function(v) t[arg.name] = v; WA.Add(data); WA.RefreshOptions() end,
})
if t[arg.name] == "specific" then
table.insert(fields, {
type = "input", name = "Unit Token", key = "specificUnit", half = true,
get = function() return t.specificUnit or "" end,
set = function(v) t.specificUnit = v; WA.Add(data) end,
})
end
elseif arg.type == "spell" then
table.insert(fields, {
type = "spell", name = arg.display or "Spell", key = arg.name,
get = function() return t[arg.name] or "" end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
})
elseif arg.type == "talent" then
table.insert(fields, {
type = "talent", name = arg.display or "Talent", key = arg.name,
get = function() return t[arg.name] or "" end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
resolve = function(v)
local found, _, _, _, tab, tier, column, icon = WA.TalentInfo(v,
(t.usePlacement and tonumber(t.talentTab)) or 0,
(t.usePlacement and tonumber(t.talentTier)) or 0,
(t.usePlacement and tonumber(t.talentColumn)) or 0)
return found and icon or nil
end,
})
elseif arg.type == "item" then
table.insert(fields, {
type = "item", name = arg.display or "Item", key = arg.name,
get = function() return t[arg.name] or "" end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
})
elseif arg.type == "text" then
table.insert(fields, {
type = "input", name = arg.display or arg.name, key = arg.name,
get = function() return t[arg.name] or "" end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
})
elseif arg.type == "range" then
-- A plain bounded number, no operator: the value *is* the setting
-- rather than one side of a comparison, so it contributes no test.
table.insert(fields, {
type = "range", name = arg.display or arg.name, key = arg.name,
min = arg.min or 0, max = arg.max or 100, step = arg.step or 1,
decimals = arg.decimals,
get = function() return t[arg.name] or arg.default or 0 end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
})
elseif arg.type == "string" then
table.insert(fields, {
type = "toggle", name = arg.display or arg.name, key = "use_" .. arg.name,
get = function() return t["use_" .. arg.name] end,
set = function(v) t["use_" .. arg.name] = v; WA.Add(data); WA.RefreshOptions() end,
})
if t["use_" .. arg.name] then
table.insert(fields, {
type = "select", name = arg.display or arg.name, key = arg.name .. "_operator", half = true,
values = STRING_OPS, labels = STRING_OP_LABELS,
get = function() return t[arg.name .. "_operator"] end,
set = function(v) t[arg.name .. "_operator"] = v; WA.Add(data) end,
})
table.insert(fields, {
type = "input", name = "Text", key = arg.name, half = true,
get = function() return t[arg.name] or "" end,
set = function(v) t[arg.name] = v; WA.Add(data) end,
})
end
elseif arg.type == "toggle" then
table.insert(fields, {
type = "toggle", name = arg.display or arg.name, key = arg.name,
get = function() return t[arg.name] end,
set = function(v)
t[arg.name] = v; WA.Add(data)
if arg.reloadOptions then WA.RefreshOptions() end
end,
})
elseif arg.type == "select" and arg.required then
table.insert(fields, {
type = "select", name = arg.display or arg.name, key = arg.name,
values = type(arg.valueList) == "function" and arg.valueList(t) or (arg.valueList or arg.values),
labels = type(arg.valueLabels) == "function" and arg.valueLabels(t) or arg.valueLabels,
get = function() return t[arg.name] end,
set = function(v)
if arg.name == "itemClassID" and t.type == "itemtypeequipped" then
local subclassValues = itemSubclassValues(v)
local found = false
for j = 1, table.getn(subclassValues) do
if subclassValues[j] == t.itemSubclassID then found = true; break end
end
if not found then t.itemSubclassID = subclassValues[1] end
end
t[arg.name] = v; WA.Add(data)
if arg.reloadOptions then WA.RefreshOptions() end
end,
})
elseif arg.type == "select" then
table.insert(fields, {
type = "toggle", name = "Use " .. (arg.display or arg.name), key = "use_" .. arg.name,
get = function() return t["use_" .. arg.name] end,
set = function(v) t["use_" .. arg.name] = v; WA.Add(data); WA.RefreshOptions() end,
})
if t["use_" .. arg.name] then
table.insert(fields, {
type = "select", name = arg.display or arg.name, key = arg.name,
values = arg.valueList or arg.values, labels = arg.valueLabels,
get = function() return t[arg.name] end,
set = function(v)
t[arg.name] = v; WA.Add(data)
if arg.reloadOptions then WA.RefreshOptions() end
end,
})
end
elseif arg.type == "number" then
table.insert(fields, {
type = "toggle", name = arg.display or arg.name, key = "use_" .. arg.name,
get = function() return t["use_" .. arg.name] end,
set = function(v) t["use_" .. arg.name] = v; WA.Add(data); WA.RefreshOptions() end,
})
if t["use_" .. arg.name] then
table.insert(fields, {
type = "opnumber", name = arg.display or arg.name, key = arg.name,
getOp = function() return t[arg.name .. "_operator"] end,
setOp = function(v) t[arg.name .. "_operator"] = v; WA.Add(data) end,
getVal = function() return t[arg.name] end,
setVal = function(v) t[arg.name] = v; WA.Add(data) end,
})
-- The second bound is offered only once the first is on, since a
-- range with no lower half is just the upper half on its own.
if arg.multiEntry then
table.insert(fields, {
type = "toggle", name = "And " .. (arg.display or arg.name),
key = "use_" .. arg.name .. "2",
get = function() return t["use_" .. arg.name .. "2"] end,
set = function(v)
t["use_" .. arg.name .. "2"] = v; WA.Add(data); WA.RefreshOptions()
end,
})
if t["use_" .. arg.name .. "2"] then
table.insert(fields, {
type = "opnumber", name = arg.display or arg.name, key = arg.name .. "2",
getOp = function() return t[arg.name .. "2_operator"] end,
setOp = function(v) t[arg.name .. "2_operator"] = v; WA.Add(data) end,
getVal = function() return t[arg.name .. "2"] end,
setVal = function(v) t[arg.name .. "2"] = v; WA.Add(data) end,
})
end
end
end
end
end
return fields
end
local function buildSummary(proto)
return function(data)
local t = WA.GetTrigger(data, 1)
if not t then return proto.displayName end
if t.spellName and t.spellName ~= "" then
return proto.displayName .. ": " .. t.spellName
end
if t.unit then
return proto.displayName .. " (" .. WA.TriggerUnit(t, "player") .. ")"
end
return proto.displayName
end
end
local systemTypes = {}
for typeName, proto in pairs(PROTOTYPES) do
-- A prototype gated on a client mod that isn't installed registers no type at
-- all, so it never reaches the picker rather than appearing there and failing
-- when chosen. Feature-by-feature degradation, not a second load gate.
if not proto.enable or proto.enable() then
WA.RegisterTriggerType(typeName, {
displayName = proto.displayName,
category = proto.category,
defaults = buildDefaults(proto),
migrate = proto.migrate,
wa2Event = proto.wa2Event,
summary = buildSummary(proto),
options = buildOptions,
})
table.insert(systemTypes, typeName)
end
end
WA.RegisterTriggerSystem(systemTypes, GenericTrigger)