energytick: let the five-second rule display as a separate bar or the old shade

The shading bar sat on top of the power bar's own fill and shrank from the
right as the window drained, which reads as part of the mana bar rather than
a countdown over it -- the same problem nameplate castbars solve by living
below the health bar instead of on it.

Show Five Second Rule Style now picks between that: a real StatusBar below
the power bar, backdrop and all, or the original translucent overlay for
anyone who prefers it. The style is read once at module load like the other
structural toggles here, not swapped live -- a /reload picks up a change.
Height and color are only meaningful for the separate-bar style, so the
GUI's Five Second Rule Height and the new appearance.castbar.fsrcolor picker
apply to it alone; the overlay is unchanged from before.

The sweep spark's own dim/solid signal (fsrEnd/fsrGain) is untouched by any
of this -- it keeps dimming through an unconfirmed window regardless of
which display, or none, is shown.

Energy/Mana Ticks -- including both five-second-rule settings -- moves from
Unit Frames > General to Unit Frames > Player, right after Powerbar: they
are C.unitframes.player-only, so General was never the right tab, and
Powerbar is the setting group they actually belong to.

README.md

@@ -1,13 +1,10 @@
 # pfUI - ClassicAPI Edition
 
-[![Octo WoW](https://img.shields.io/badge/Octo%20WoW-1.18.1-brightgreen.svg)](https://octowow.st/)
 [![ClassicAPI](https://img.shields.io/badge/ClassicAPI-Required-purple.svg)](https://github.com/brues-code/ClassicAPI)
 [![Nampower](https://img.shields.io/badge/Nampower-Required-purple.svg)](https://github.com/brues-code/nampower)
 [![SuperWoW](https://img.shields.io/badge/SuperWoW-Optional-yellow.svg)](https://github.com/balakethelock/SuperWoW)
 [![UnitXP](https://img.shields.io/badge/UnitXP__SP3-Optional-yellow.svg)](https://github.com/brues-code/UnitXP_SP3)
 
-**A pfUI fork specifically optimized for ClassicAPI on [Octo WoW](https://octowow.st/)**
-
 This version includes significant performance improvements and DLL-enhanced features.
 
 ## Installation
@@ -18,7 +15,7 @@ This version includes significant performance improvements and DLL-enhanced feat
 
 ## DLL Enhancements
 
-Since pfUI 6.0.0 includes integrations with client-side DLLs for enhanced functionality. These DLLs are permitted on Octo WoW:
+Since pfUI 6.0.0 includes integrations with client-side DLLs for enhanced functionality:
 
 ### [ClassicAPI](https://github.com/brues-code/ClassicAPI)
 

api/api.lua

@@ -1333,6 +1333,32 @@ function pfUI.api.CreateBackdropShadow(f)
   f.backdrop_shadow:SetBackdropBorderColor(0, 0, 0, tonumber(pfUI_config.appearance.border.shadow_intensity))
 end
 
+-- [ Set Castbar Shield ]
+-- Colors a castbar for a cast that none of the player's own interrupts or
+-- silences can stop. The bar and the icon's border both take the shield color,
+-- so the state still reads on a bar configured without an icon. Not shielded
+-- restores the normal cast/channel color and the configured border.
+-- 'bar'        [frame]     the castbar statusbar
+-- 'icon'       [frame]     the icon frame, or nil for a bar without one
+-- 'shielded'   [bool]      whether the cast is uninterruptible
+-- 'isChannel'  [bool]      selects the unshielded color
+function pfUI.api.SetCastbarShield(bar, icon, shielded, isChannel)
+  if shielded then
+    bar:SetStatusBarColor(pfUI.api.GetStringColor(C.appearance.castbar.shieldcolor))
+  else
+    bar:SetStatusBarColor(pfUI.api.GetStringColor(C.appearance.castbar[isChannel and "channelcolor" or "castbarcolor"]))
+  end
+
+  local iconborder = icon and icon.backdrop
+  if not iconborder then return end
+
+  if shielded then
+    iconborder:SetBackdropBorderColor(pfUI.api.GetStringColor(C.appearance.castbar.shieldcolor))
+  else
+    iconborder:SetBackdropBorderColor(pfUI.api.GetStringColor(C.appearance.border.color))
+  end
+end
+
 -- [ Bar Layout Options ] --
 -- 'barsize'  size of bar in number of buttons
 -- returns:   array of options as strings for pfUI.gui.bar

api/config.lua

@@ -156,6 +156,8 @@ function pfUI:LoadConfig()
   pfUI:UpdateConfig("appearance", "castbar",     "castbarcolor",     ".7,.7,.9,.8")
   pfUI:UpdateConfig("appearance", "castbar",     "channelcolor",     ".9,.9,.7,.8")
   pfUI:UpdateConfig("appearance", "castbar",     "failcolor",        "1,.2,.2,.8")
+  pfUI:UpdateConfig("appearance", "castbar",     "shieldcolor",      ".8,.45,.45,.8")
+  pfUI:UpdateConfig("appearance", "castbar",     "fsrcolor",         ".9,.6,.2,.8")
   pfUI:UpdateConfig("appearance", "castbar",     "texture",          "Interface\\AddOns\\pfUI\\img\\bar")
   pfUI:UpdateConfig("appearance", "infight",     "screen",           "0")
   pfUI:UpdateConfig("appearance", "infight",     "aggro",            "0")
@@ -324,6 +326,9 @@ function pfUI:LoadConfig()
   pfUI:UpdateConfig("unitframes", "player",      "showRest",                "0")
   pfUI:UpdateConfig("unitframes", "player",      "energy",                  "1")
   pfUI:UpdateConfig("unitframes", "player",      "manatick",                "0")
+  pfUI:UpdateConfig("unitframes", "player",      "showfsr",                 "1")
+  pfUI:UpdateConfig("unitframes", "player",      "fsrheight",               "4")
+  pfUI:UpdateConfig("unitframes", "player",      "fsrstyle",                "0")
   pfUI:UpdateConfig("unitframes", "player",      "display_haste",           "0")
   pfUI:UpdateConfig("unitframes", "player",      "display_haste_color",     "1,1,1,1")
   pfUI:UpdateConfig("unitframes", "player",      "display_spellpower",      "1")

modules/castbar.lua

@@ -86,7 +86,7 @@ pfUI:RegisterModule("castbar", function ()
 
   -- Stamp the bar with cast data and render text/icon/lag once. OnUpdate
   -- then animates the fill from this state without touching C_Spell.
-  local function StampBar(cb, name, tex, startMs, endMs, spellID, isChannel, delayMs, isTradeskill, rank)
+  local function StampBar(cb, name, tex, startMs, endMs, spellID, isChannel, delayMs, isTradeskill, rank, noInterrupt)
     cb.startTime = startMs
     cb.endTime = endMs
     cb.isChannel = isChannel
@@ -97,7 +97,10 @@ pfUI:RegisterModule("castbar", function ()
     cb:SetAlpha(1)
     cb.fadeout = nil
 
-    cb.bar:SetStatusBarColor(GetStringColor(C.appearance.castbar[isChannel and "channelcolor" or "castbarcolor"]))
+    -- Shield an uninterruptible cast. Not on the player's own bar: the flag is
+    -- measured against the reader's own interrupts and silences, so on your own
+    -- cast it answers a question nobody asked.
+    SetCastbarShield(cb.bar, cb.icon, noInterrupt and cb.unitstr ~= "player", isChannel)
 
     -- Rank: prefer the value the UNIT_SPELLCAST_* event delivered (arg5, passed
     -- through by RefreshBar). Only the retarget re-poll has no event in hand, so
@@ -152,10 +155,10 @@ pfUI:RegisterModule("castbar", function ()
       ClearBar(cb)
       return
     end
-    local name, _, tex, startMs, endMs, isTradeskill, _, _, spellID, _, delayMs = C_Spell.UnitCastingInfo(query)
+    local name, _, tex, startMs, endMs, isTradeskill, _, noInterrupt, spellID, _, delayMs = C_Spell.UnitCastingInfo(query)
     local isChan
     if not name then
-      name, _, tex, startMs, endMs, _, _, spellID = C_Spell.UnitChannelInfo(query)
+      name, _, tex, startMs, endMs, _, noInterrupt, spellID = C_Spell.UnitChannelInfo(query)
       isChan = true
     end
     -- Synthetic fallback for abilities the engine treats as instant-cast but
@@ -169,7 +172,7 @@ pfUI:RegisterModule("castbar", function ()
       end
     end
     if name and startMs and endMs then
-      StampBar(cb, name, tex, startMs, endMs, spellID, isChan, delayMs, isTradeskill, rank)
+      StampBar(cb, name, tex, startMs, endMs, spellID, isChan, delayMs, isTradeskill, rank, noInterrupt)
     else
       ClearBar(cb)
     end

modules/energytick.lua

@@ -89,6 +89,13 @@ pfUI:RegisterModule("energytick", function()
     return C.unitframes.player.pwidth ~= "-1" and C.unitframes.player.pwidth or C.unitframes.player.width
   end
 
+  local rawborder, default_border = GetBorderSize("unitframes")
+  local cbtexture = pfUI.media[C.appearance.castbar.texture]
+
+  -- style is read once: switching it in the GUI needs a /reload, same as the
+  -- other structural (not cosmetic) toggles in this file
+  local fsrOverlay = C.unitframes.player.fsrstyle == "1"
+
   -- was this gain the regen tick? if so, re-anchor the sweep on it
   local function lockTick(frame)
     local now, period = GetTime(), getAdjustedTickTimer()
@@ -199,11 +206,21 @@ pfUI:RegisterModule("energytick", function()
     end
     this.tick = GetTime() + 0.020  -- ~50 FPS
 
-    -- five-second rule drains to nothing
+    -- five-second rule drains to nothing. The display is cosmetic and can be
+    -- hidden on its own; the window itself (fsrEnd/fsrGain) keeps running
+    -- either way -- it still dims the sweep spark below.
     local remaining = this.fsrEnd and (this.fsrEnd - GetTime()) or 0
     if this.mode == "MANA" and remaining > 0 then
-      this.fsrbar:SetWidth(getBarWidth() * remaining / FIVE_SECOND_RULE)
+      if C.unitframes.player.showfsr == "1" then
-      this.fsrbar:Show()
+        if fsrOverlay then
+          this.fsrbar:SetWidth(getBarWidth() * remaining / FIVE_SECOND_RULE)
+        else
+          this.fsrbar:SetValue(remaining)
+        end
+        this.fsrbar:Show()
+      else
+        this.fsrbar:Hide()
+      end
     else
       this.fsrSpell, this.fsrEnd, this.fsrGain = nil, nil, nil
       this.fsrbar:Hide()
@@ -240,10 +257,26 @@ pfUI:RegisterModule("energytick", function()
     this.spark:SetPoint("LEFT", pos - ((C.unitframes.player.pheight + 5) / 2), 0)
   end)
 
-  energytick.fsrbar = energytick:CreateTexture(nil, "ARTWORK")
+  if fsrOverlay then
-  energytick.fsrbar:SetTexture(1, 1, 1, .15)
+    -- classic style: a translucent shade on top of the power bar's own fill
-  energytick.fsrbar:SetPoint("TOPLEFT", 0, 0)
+    energytick.fsrbar = energytick:CreateTexture(nil, "ARTWORK")
-  energytick.fsrbar:SetPoint("BOTTOMLEFT", 0, 0)
+    energytick.fsrbar:SetTexture(1, 1, 1, .15)
+    energytick.fsrbar:SetPoint("TOPLEFT", 0, 0)
+    energytick.fsrbar:SetPoint("BOTTOMLEFT", 0, 0)
+  else
+    -- a real bar below the power bar, not an overlay on top of it -- the same
+    -- treatment nameplate castbars get relative to the health bar, so the
+    -- window can't be mistaken for missing mana
+    energytick.fsrbar = CreateFrame("StatusBar", nil, pfUI.uf.player)
+    energytick.fsrbar:SetStatusBarTexture(cbtexture)
+    energytick.fsrbar:SetMinMaxValues(0, FIVE_SECOND_RULE)
+    energytick.fsrbar:SetPoint("TOPLEFT", pfUI.uf.player.power.bar, "BOTTOMLEFT", 0, -default_border * 2)
+    energytick.fsrbar:SetPoint("TOPRIGHT", pfUI.uf.player.power.bar, "BOTTOMRIGHT", 0, -default_border * 2)
+    energytick.fsrbar:SetHeight(tonumber(C.unitframes.player.fsrheight) or 4)
+    energytick.fsrbar:SetStatusBarColor(GetStringColor(C.appearance.castbar.fsrcolor))
+    CreateBackdrop(energytick.fsrbar, default_border)
+    CreateBackdropShadow(energytick.fsrbar)
+  end
   energytick.fsrbar:Hide()
 
   energytick.spark = energytick:CreateTexture(nil, "OVERLAY")
@@ -256,6 +289,10 @@ pfUI:RegisterModule("energytick", function()
   function pfUI.uf.player.UpdateConfig()
     energytick.spark:SetHeight(C.unitframes.player.pheight + 15)
     energytick.spark:SetWidth(C.unitframes.player.pheight + 5)
+    if not fsrOverlay then
+      energytick.fsrbar:SetHeight(tonumber(C.unitframes.player.fsrheight) or 4)
+      energytick.fsrbar:SetStatusBarColor(GetStringColor(C.appearance.castbar.fsrcolor))
+    end
     hookUpdateConfig(pfUI.uf.player)
   end
 end)

modules/gui.lua

@@ -2072,8 +2072,6 @@ pfUI:RegisterModule("gui", function ()
       CreateConfig(nil, T["Combopoint Width"], C.unitframes, "combowidth")
       CreateConfig(nil, T["Combopoint Height"], C.unitframes, "comboheight")
       CreateConfig(nil, T["Show Resting"], C.unitframes.player, "showRest", "checkbox")
-      CreateConfig(nil, T["Enable Energy Ticks"], C.unitframes.player, "energy", "checkbox")
-      CreateConfig(nil, T["Enable Mana Ticks"], C.unitframes.player, "manatick", "checkbox")
       CreateConfig(nil, T["Detect Enemy Buffs"], C.unitframes, "buffdetect", "checkbox", nil, nil, nil, nil)
       CreateConfig(nil, T["Raid Mark Icon Style"], C.unitframes, "blizzard_raidicons", "dropdown", function() return {"1:Original Blizzard", "0:pfUI Design"} end)
 
@@ -2320,6 +2318,15 @@ pfUI:RegisterModule("gui", function ()
         CreateConfig(U[c], T["Right Text Y Offset"], C.unitframes[c], "txtpowerrightoffy")
         CreateConfig(U[c], T["Power Bar Anchor"], C.unitframes[c], "panchor", "dropdown", pfUI.gui.dropdowns.uf_powerbar_position)
 
+        if c == "player" then
+          CreateConfig(nil, T["Energy/Mana Ticks"], nil, nil, "header")
+          CreateConfig(nil, T["Enable Energy Ticks"], C.unitframes[c], "energy", "checkbox")
+          CreateConfig(nil, T["Enable Mana Ticks"], C.unitframes[c], "manatick", "checkbox")
+          CreateConfig(nil, T["Show Five Second Rule"], C.unitframes[c], "showfsr", "checkbox")
+          CreateConfig(nil, T["Five Second Rule Style"], C.unitframes[c], "fsrstyle", "dropdown", function() return {"0:Separate Bar", "1:Overlay"} end)
+          CreateConfig(nil, T["Five Second Rule Height"], C.unitframes[c], "fsrheight")
+        end
+
         CreateConfig(U[c], T["Combat Text"], nil, nil, "header")
         CreateConfig(U[c], T["Show Combat Text"], C.unitframes[c], "hitindicator", "checkbox")
         CreateConfig(U[c], T["Combat Text Font"], C.unitframes[c], "hitindicatorfont", "dropdown", pfUI.gui.dropdowns.fonts)
@@ -2792,6 +2799,8 @@ pfUI:RegisterModule("gui", function ()
       CreateConfig(nil, T["Use Unit Fonts"], C.castbar, "use_unitfonts", "checkbox")
       CreateConfig(nil, T["Casting Color"], C.appearance.castbar, "castbarcolor", "color")
       CreateConfig(nil, T["Channeling Color"], C.appearance.castbar, "channelcolor", "color")
+      CreateConfig(nil, T["Uninterruptible Color"], C.appearance.castbar, "shieldcolor", "color")
+      CreateConfig(nil, T["Five Second Rule Color"], C.appearance.castbar, "fsrcolor", "color")
       CreateConfig(nil, T["Castbar Texture"], C.appearance.castbar, "texture", "dropdown", pfUI.gui.dropdowns.uf_bartexture)
       CreateConfig(nil, T["Disable Blizzard Castbar"], C.castbar.player, "hide_blizz", "checkbox")
     end)

modules/nameplates.lua

@@ -77,10 +77,10 @@ pfUI:RegisterModule("nameplates", function ()
   -- vs channel itself. Never called per frame.
   local function PollCastInfo(unit)
     if not unit then return nil end
-    local name, _, texture, startMs, endMs, _, _, _, spellID = C_Spell.UnitCastingInfo(unit)
+    local name, _, texture, startMs, endMs, _, _, noInterrupt, spellID = C_Spell.UnitCastingInfo(unit)
     local isChannel
     if not name then
-      name, _, texture, startMs, endMs, _, _, spellID = C_Spell.UnitChannelInfo(unit)
+      name, _, texture, startMs, endMs, _, noInterrupt, spellID = C_Spell.UnitChannelInfo(unit)
       isChannel = true
     end
     if not name or not startMs or not endMs then return nil end
@@ -92,6 +92,7 @@ pfUI:RegisterModule("nameplates", function ()
       endTime   = endMs / 1000,
       duration  = (endMs - startMs) / 1000,
       isChannel = isChannel,
+      noInterrupt = noInterrupt,
     }
   end
 
@@ -1751,7 +1752,7 @@ nameplates:RegisterEvent("PLAYER_GUILD_UPDATE")
       -- Relative 0..duration range to avoid float precision loss with large
       -- absolute timestamps.
       nameplate.castbar:SetMinMaxValues(0, duration)
-      nameplate.castbar:SetStatusBarColor(GetStringColor(C.appearance.castbar[(isChannel and "channelcolor" or "castbarcolor")]))
+      SetCastbarShield(nameplate.castbar, nameplate.castbar.icon, castInfo.noInterrupt, isChannel)
       if castInfo.icon then
         nameplate.castbar.icon.tex:SetTexture(castInfo.icon)
         nameplate.castbar.icon.tex:SetTexCoord(.1,.9,.1,.9)