Centralize cooldown setup and settings

Every pfUI cooldown is now made by CreateCooldown(parent, kind) in the new api/cooldown.lua, which replaces the cooldown module. A kind names what the cooldown times: actionbar, bags, blizzard (spellbook and character), unitframe, indicator, nameplate, buff, tooltip, totem or lossofcontrol. The pfCooldownType, pfCooldownStyleText, pfCooldownStyleAnimation and pfCooldownSize fields are gone. The new file owns everything the cooldowns share: - the numbers' font and size - the formatter - each kind's numbers, sweep and sweep direction - the GCD threshold for spell kinds - the CooldownFrame_SetTimer hook for other addons' Cooldown frames UpdateCooldowns applies changed settings to every cooldown at once. GetAuraTimer moves here from the unit frames. All settings live in one C.cooldown table, on one page: Settings -> Cooldown. It has the shared font, size, threshold, tenths and colors, then "Show Numbers On", "Show Sweep On" and "Reverse Sweep On" lists with a checkbox per kind. The per-module options are removed: - each unit frame's timer text, animation and reverse, and the indicators' "Show Time Left" - the nameplate debuff timer options - the Blizzard and foreign font sizes and toggles - Action Bars' cooldown text size - the reverse options of bars, bags, buffs and totems The old appearance.cd settings are not migrated. The player buff frame and the tooltip aura icons now show the native countdown too, which replaces their own text and OnUpdate ticking. The buff frame keeps its inside or below-the-icon placement. Weapon enchants report only their time left, so they start through SetCooldownTimeLeft: numbers, no sweep. A slim poll remains for their charges and renewals, since no event reports those. Buff indicators now take the aura's real duration, which gives them a correct sweep. The spellbook and character slots now hide GCD numbers like the other spell cooldowns.
2026-11-01 16:36:56 +00:00 · 2026-10-31 19:17:14 -05:00
parent 149c8cb3c3
commit 907d282a68
26 changed files with 535 additions and 546 deletions
@@ -0,0 +1,194 @@
+-- load pfUI environment
+setfenv(1, pfUI:GetEnvironment())
+
+-- Every pfUI cooldown is a Cooldown frame from CreateCooldown, made for one
+-- kind of timer. Settings -> Cooldown (C.cooldown) sets for each kind its
+-- countdown numbers, its sweep and the sweep's direction, and shares one font
+-- and one formatter between them all. The numbers are the frame's own
+-- countdown (ClassicAPI): the engine ticks them, gated by the
+-- countdownForCooldowns cvar. Other addons' Cooldown frames take the
+-- "foreign" settings as their timers start.
+
+-- kinds that time spells or items: no numbers for the global cooldown
+local spell = { actionbar = true, bags = true, blizzard = true, foreign = true }
+
+-- every cooldown CreateCooldown made, for UpdateCooldowns
+local cooldowns = {}
+
+local function ColorCode(color)
+  local r, g, b = pfUI.api.GetStringColor(color)
+  return pfUI.api.rgbhex(r, g, b)
+end
+
+-- The formatter behind every pfUI time: the number in its unit's color,
+-- rounded up, with a unit (m/h/d) once the unit below passes 99. Cooldown
+-- frames share it instead of copying it, so new breakpoints reach every
+-- countdown on its next update.
+local formatter
+
+local function UpdateFormatter()
+  local up = Enum.NumericRuleFormatRounding.Up
+  local tenths = C.cooldown.milliseconds == "1"
+
+  formatter:SetBreakpoints({
+    { threshold = 0, step = tenths and .1 or 1, rounding = up, format = ColorCode(C.cooldown.lowcolor) .. (tenths and "%.1f" or "%d") .. "|r" },
+    { threshold = 5, step = 1, rounding = up, format = ColorCode(C.cooldown.normalcolor) .. "%d|r" },
+    { threshold = 99, format = ColorCode(C.cooldown.minutecolor) .. "%d|rm", components = { { div = 60, step = 1, rounding = up } } },
+    { threshold = 5940, format = ColorCode(C.cooldown.hourcolor) .. "%d|rh", components = { { div = 3600, step = 1, rounding = up } } },
+    { threshold = 356400, format = ColorCode(C.cooldown.daycolor) .. "%d|rd", components = { { div = 86400, step = 1, rounding = up } } },
+  })
+end
+
+local function GetFormatter()
+  if not formatter then
+    formatter = C_StringUtil.CreateNumericRuleFormatter()
+    UpdateFormatter()
+  end
+  return formatter
+end
+
+-- [ GetCooldownFontSize ] --
+-- 'height'   [number]   the height of the frame the numbers sit on
+-- return     [number]   the font size of cooldown numbers on that frame
+function pfUI.api.GetCooldownFontSize(height)
+  local size = tonumber(C.cooldown.font_size)
+  if C.cooldown.dynamicsize == "1" and height > 0 then
+    size = math.max(height * .64, size)
+  end
+  return size
+end
+
+-- sizes the numbers to the cooldown's parent; the size follows its height,
+-- so a timer start calls this again whenever that height changed
+local function UpdateFont(cooldown)
+  local height = (cooldown:GetParent() or cooldown):GetHeight()
+  cooldown.pfCountdownHeight = height
+  cooldown:GetCountdownFontString():SetFont(pfUI.media[C.cooldown.font], pfUI.api.GetCooldownFontSize(height), "OUTLINE")
+end
+
+-- applies the settings of its kind to one of pfUI's cooldowns
+local function SetupCooldown(cooldown)
+  local kind = cooldown.pfCooldownKind
+  local config = C.cooldown[kind]
+  local sweep = config.animation == "1" and not cooldown.pfTimeLeftOnly
+
+  cooldown:SetHideCountdownNumbers(config.text ~= "1")
+  cooldown:SetDrawSwipe(sweep)
+  cooldown:SetDrawBling(sweep)
+  cooldown:SetReverse(config.reverse == "1")
+  cooldown:SetMinimumCountdownDuration(spell[kind] and tonumber(C.cooldown.threshold) * 1000 or 0)
+  cooldown:SetCountdownFormatter(GetFormatter())
+  UpdateFont(cooldown)
+end
+
+-- applies the "foreign" settings to another addon's cooldown. They only take
+-- the numbers or the sweep away, which the addon may have set up itself, so
+-- turning one back on needs a reload.
+local function SetupForeign(cooldown)
+  local config = C.cooldown.foreign
+
+  if config.animation ~= "1" then
+    cooldown:SetDrawSwipe(false)
+    cooldown:SetDrawBling(false)
+  end
+
+  -- omnicc's flag for cooldowns that want no numbers
+  if config.text ~= "1" or cooldown.noCooldownCount then
+    cooldown:SetHideCountdownNumbers(true)
+    return
+  end
+
+  cooldown:SetMinimumCountdownDuration(tonumber(C.cooldown.threshold) * 1000)
+  cooldown:SetCountdownFormatter(GetFormatter())
+  UpdateFont(cooldown)
+end
+
+-- runs as a pfUI cooldown's timer starts: a timer with a total brings back
+-- the sweep a time-left-only one took away, and the font follows a changed
+-- height
+local function StartTimer(cooldown, timeleftOnly)
+  if cooldown.pfTimeLeftOnly ~= timeleftOnly then
+    cooldown.pfTimeLeftOnly = timeleftOnly
+    SetupCooldown(cooldown)
+  elseif cooldown:GetParent():GetHeight() ~= cooldown.pfCountdownHeight then
+    UpdateFont(cooldown)
+  end
+end
+
+-- every timer, pfUI's or another addon's, Cooldown frame or 1.12 indicator
+-- Model, is started through CooldownFrame_SetTimer
+hooksecurefunc("CooldownFrame_SetTimer", function(cooldown)
+  -- the Models have no numbers and keep the stock timer
+  if not cooldown:IsObjectType("Cooldown") then return end
+
+  if cooldown.pfCooldownKind then
+    StartTimer(cooldown, nil)
+  else
+    SetupForeign(cooldown)
+  end
+end)
+
+-- [ CreateCooldown ] --
+-- Creates one of pfUI's cooldowns: a Cooldown frame over all of 'parent'
+-- with the settings of its kind. Start it with CooldownFrame_SetTimer.
+-- 'parent'   [frame]    the frame the cooldown covers
+-- 'kind'     [string]   what it times, a group of C.cooldown: actionbar,
+--                       bags, blizzard, unitframe, indicator, nameplate,
+--                       buff, tooltip, totem or lossofcontrol
+-- 'name'     [string]   optional frame name
+-- return     [frame]    the Cooldown frame
+function pfUI.api.CreateCooldown(parent, kind, name)
+  local cooldown = CreateFrame("Cooldown", name, parent, "CooldownFrameTemplate")
+  cooldown.pfCooldownKind = kind
+  table.insert(cooldowns, cooldown)
+  SetupCooldown(cooldown)
+  return cooldown
+end
+
+-- [ SetCooldownTimeLeft ] --
+-- Starts a cooldown from its time left alone, for timers that report no
+-- total (weapon enchants): the numbers show, the sweep stays off until a
+-- timer with a total starts.
+-- 'cooldown'   [frame]    a cooldown from CreateCooldown
+-- 'timeleft'   [number]   the seconds left
+function pfUI.api.SetCooldownTimeLeft(cooldown, timeleft)
+  StartTimer(cooldown, true)
+  cooldown:SetCooldown(GetTime(), timeleft)
+end
+
+-- [ UpdateCooldowns ] --
+-- Applies changed cooldown settings to every pfUI cooldown.
+function pfUI.api.UpdateCooldowns()
+  if formatter then UpdateFormatter() end
+  for _, cooldown in ipairs(cooldowns) do
+    SetupCooldown(cooldown)
+  end
+end
+
+-- [ GetAuraTimer ] --
+-- The cooldown start and duration of an aura from C_UnitAuras, 0, 0 when it
+-- has none. Talent-extended auras run past their Spell.dbc base duration, and
+-- a start in the future would hold the timer until then, so the start is
+-- capped to now.
+-- 'duration'         [number]   the aura's duration
+-- 'expirationTime'   [number]   the aura's expiration time
+-- return             [number]   start, duration
+function pfUI.api.GetAuraTimer(duration, expirationTime)
+  if expirationTime <= 0 then return 0, 0 end
+
+  local now = GetTime()
+  local start, dur = expirationTime - duration, duration
+  if start > now or dur <= 0 then
+    start, dur = now, expirationTime - now
+  end
+
+  if dur <= 0 then return 0, 0 end
+  return start, dur
+end
+
+-- [ GetColoredTimeString ] --
+-- 'remaining'   [number]   the time in seconds that should be converted
+-- return        [string]   the time as cooldown numbers show it
+function pfUI.api.GetColoredTimeString(remaining)
+  return GetFormatter():FormatNumber(remaining)
+end