[Feature] Frame Highlighting (#196)

* annotations

* widget kind const

* defaults

* add menu options

* add color options

* Implement Widget

* add widget to all units

* locale

Cell_UnitFrames.toc

@@ -77,6 +77,7 @@ Widgets/Auras/Dispels.lua
 Widgets/Auras/Totems.lua
 
 Widgets/Misc/Fader.lua
+Widgets/Misc/Highlight.lua
 
 UnitFrames/UnitButton.xml
 UnitFrames/UnitButton.lua

Data/Constants.lua

@@ -97,7 +97,8 @@ const.WIDGET_KIND = {
     HEAL_ABSORB = "healAbsorb",
     DISPELS = "dispels",
     TOTEMS = "totems",
-    FADER = "fader"
+    FADER = "fader",
+    HIGHLIGHT = "highlight",
 }
 
 ---@enum OPTION_KIND
@@ -181,6 +182,8 @@ const.OPTION_KIND = {
     TIME_TO_HOLD            = "timeToHold",
     INTERRUPTED_LABEL       = "interruptedLabel",
     ICON_TEXTURE            = "iconTexture",
+    TARGET                  = "target",
+    HOVER                   = "hover",
 }
 
 ---@enum AURA_OPTION_KIND

Data/Defaults.lua

@@ -137,6 +137,7 @@ Defaults.Options.glow = {
 ---| "healAbsorb"
 ---| "unitFrames"
 ---| "classBar"
+---| "highlight"
 
 ---@class Defaults.Colors
 Defaults.Colors = {
@@ -220,6 +221,10 @@ Defaults.Colors = {
     },
     classBar = {
         texture = "Interface\\Buttons\\WHITE8X8",
+    },
+    highlight = {
+        target = { 1, 0.3, 0.3, 1 },
+        hover = { 1, 1, 1, 1 }
     }
 }
 
@@ -309,6 +314,10 @@ Defaults.ColorsMenuOrder = {
     },
     classBar = {
         { "texture", "texture" },
+    },
+    highlight = {
+        { "target", "rgb" },
+        { "hover",  "rgb" },
     }
 }
 
@@ -772,7 +781,14 @@ Defaults.Widgets = {
         fadeDuration = 0.25,
         maxAlpha = 1,
         minAlpha = 0.35,
-    }
+    },
+    ---@type HighlightWidgetTable
+    highlight = {
+        enabled = false,
+        hover = true,
+        target = true,
+        size = 1,
+    },
 }
 
 -- Boss Widgets
@@ -903,7 +919,8 @@ Defaults.Layouts = {
             castBar = Defaults.Widgets.castBar,
             healAbsorb = Defaults.Widgets.healAbsorb,
             dispels = Defaults.Widgets.dispels,
-            fader = Defaults.Widgets.fader
+            fader = Defaults.Widgets.fader,
+            highlight = Defaults.Widgets.highlight,
         },
         sameSizeAsPlayer = false,
         clickCast = false,
@@ -936,7 +953,8 @@ Defaults.Layouts = {
             castBar = Defaults.Widgets.castBar,
             healAbsorb = Defaults.Widgets.healAbsorb,
             dispels = Defaults.Widgets.dispels,
-            fader = Defaults.Widgets.fader
+            fader = Defaults.Widgets.fader,
+            highlight = Defaults.Widgets.highlight,
         },
         anchorToParent = false,
         parent = CUF.constants.UNIT.PLAYER,
@@ -965,7 +983,8 @@ Defaults.Layouts = {
             powerText = Defaults.Widgets.powerText,
             levelText = Defaults.Widgets.levelText,
             raidIcon = Defaults.Widgets.raidIcon,
-            fader = Defaults.Widgets.fader
+            fader = Defaults.Widgets.fader,
+            highlight = Defaults.Widgets.highlight,
         },
         sameSizeAsPlayer = false,
         clickCast = false,
@@ -1002,7 +1021,8 @@ Defaults.Layouts = {
             castBar = Defaults.Widgets.castBar,
             healAbsorb = Defaults.Widgets.healAbsorb,
             dispels = Defaults.Widgets.dispels,
-            fader = Defaults.Widgets.fader
+            fader = Defaults.Widgets.fader,
+            highlight = Defaults.Widgets.highlight,
         },
         sameSizeAsPlayer = false,
         clickCast = false,
@@ -1041,7 +1061,8 @@ Defaults.Layouts = {
             buffs = Defaults.Widgets_Boss.buffs,
             debuffs = Defaults.Widgets_Boss.debuffs,
             castBar = Defaults.Widgets_Boss.castBar,
-            fader = Defaults.Widgets.fader
+            fader = Defaults.Widgets.fader,
+            highlight = Defaults.Widgets.highlight,
         },
         healthBarColorType = CUF.constants.UnitButtonColorType.CELL,
         healthLossColorType = CUF.constants.UnitButtonColorType.CUSTOM,

Locales/enUS.lua

@@ -175,6 +175,7 @@ L.classBar = "Class Bar"
 L.healthBar = "Health Bar"
 L.healAbsorb = "Heal Absorb"
 L.totems = "Totems"
+L.highlight = "Highlight"
 
 -- Misc
 L.Frame = "Frame"
@@ -391,3 +392,4 @@ L.HelpTip_BlizzardFramesToggle = "Click here to toggle Blizzard Frames"
 -- Aliases
 -- !!DO NOT ADD TO CURSEFORGE!!
 L.unitFrames = L.UnitFrames
+L.hover = L.Hover

Menu/Builder.lua

@@ -63,6 +63,7 @@ Builder.MenuOptions = {
     HideOutOfCombat = 36,
     Glow = 37,
     IconTexture = 38,
+    Highlight = 39,
 }
 
 local FAILED = FAILED or "Failed"
@@ -2143,6 +2144,31 @@ function Builder:CreateTotemOptions(parent, widgetName)
     return f
 end
 
+-------------------------------------------------
+-- MARK: Highlight
+-------------------------------------------------
+
+---@param parent Frame
+---@param widgetName WIDGET_KIND
+---@return HighlightOptions
+function Builder:CreateHighlightOptions(parent, widgetName)
+    ---@class HighlightOptions: OptionsFrame
+    local f = CUF:CreateFrame(nil, parent, 1, 1, true, true)
+    f.id = "HighlightOptions"
+    f.optionHeight = 65
+
+    local targetCB = self:CreateCheckBox(f, widgetName, L.target, const.OPTION_KIND.TARGET)
+    targetCB:SetPoint("TOPLEFT", 0, 10)
+    local hoverCB = self:CreateCheckBox(f, widgetName, L.Hover, const.OPTION_KIND.HOVER)
+    self:AnchorRightOfCB(hoverCB, targetCB)
+
+    local sizeSlider = self:CreateSlider(f, widgetName, L["Highlight Size"], nil, -5, 5,
+        const.OPTION_KIND.SIZE)
+    self:AnchorBelow(sizeSlider, targetCB)
+
+    return f
+end
+
 -------------------------------------------------
 -- MARK: MenuBuilder.MenuFuncs
 -- Down here because of annotations
@@ -2187,4 +2213,5 @@ Builder.MenuFuncs = {
     [Builder.MenuOptions.HideOutOfCombat] = Builder.CreateHideOutOfCombat,
     [Builder.MenuOptions.Glow] = Builder.CreateGlowOptions,
     [Builder.MenuOptions.IconTexture] = Builder.CreateIconTextureOptions,
+    [Builder.MenuOptions.Highlight] = Builder.CreateHighlightOptions,
 }

Menu/ColorTab.lua

@@ -72,7 +72,7 @@ local function CreateColorPicker(which, colorName, colorTable, parent)
     cp:SetColor(colorTable[colorName])
     cp.onChange = function(r, g, b, a)
         DB.SetColor(which, colorName, { r, g, b, a })
-        if which == "castBar" or which == "shieldBar" or which == "healAbsorb" then
+        if which == "castBar" or which == "shieldBar" or which == "healAbsorb" or which == "highlight" then
             CUF:Fire("UpdateWidget", DB.GetMasterLayout(), nil, which, const.OPTION_KIND.COLOR)
         elseif which == "essence"
             or which == "classResources"

WidgetAnnotations.lua

@@ -20,6 +20,7 @@
 ---| DispelsWidgetTable
 ---| TotemsWidgetTable
 ---| FaderWidgetTable
+---| HighlightWidgetTable
 
 ---@alias Widget
 ---| NameTextWidget
@@ -41,6 +42,7 @@
 ---| DispelsWidget
 ---| TotemsWidget
 ---| FaderWidget
+---| HighlightWidget
 
 ---@class CUFUnitButton.Widgets
 ---@field healthBar HealthBarWidget
@@ -70,6 +72,7 @@
 ---@field dispels DispelsWidget
 ---@field totems TotemsWidget
 ---@field fader FaderWidget
+---@field highlight HighlightWidget
 
 ---@class BaseWidget
 ---@field enabled boolean
@@ -324,6 +327,12 @@
 ---@field maxAlpha number
 ---@field minAlpha number
 
+---@class HighlightWidgetTable
+---@field enabled boolean
+---@field hover boolean
+---@field target boolean
+---@field size number
+
 -------------------------------------------------
 -- MARK: Generic Options
 -------------------------------------------------