feat: Change various display markers with option to hide in combat

CustomiseDialog/WidgetsConfiguration.lua

@@ -547,9 +547,34 @@ addonTable.CustomiseDialog.WidgetsConfig = {
               return details.color
             end,
           },
+          {
+            label = addonTable.Locales.HIDE_IN_COMBAT,
+            kind = "dropdown",
+            getInitData = function()
+              return {
+                addonTable.Locales.ALWAYS,
+                addonTable.Locales.NEVER,
+              }, {
+                "Always",
+                "Never",
+              }
+            end,
+            setter = function(details, value)
+              details.combatState = value
+            end,
+            getter = function(details)
+              return details.combatState or "Never"
+            end
+          },
         },
       },
     },
+    ["elite"] = {
+      {
+        label = addonTable.Locales.GENERAL,
+        entries = {},
+      },
+    },
     ["castIcon"] = {
       {
         label = addonTable.Locales.GENERAL,

Display/CannotInterruptMarker.lua

@@ -1,7 +1,7 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.CannotInterruptMarkerMixin = {}
+addonTable.Display.CannotInterruptMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.CannotInterruptMarkerMixin:SetUnit(unit)
   self.unit = unit
@@ -17,6 +17,7 @@ function addonTable.Display.CannotInterruptMarkerMixin:SetUnit(unit)
     self:RegisterUnitEvent("UNIT_SPELLCAST_INTERRUPTED", self.unit)
     self:RegisterUnitEvent("UNIT_SPELLCAST_FAILED", self.unit)
 
+    self:RegisterCombatEvents()
 
     self:ApplyCasting()
   else
@@ -47,6 +48,9 @@ function addonTable.Display.CannotInterruptMarkerMixin:ApplyCasting()
     else
       self.marker:SetShown(notInterruptible)
     end
+    if self:ShouldHideForCombat() then
+      self.marker:Hide()
+    end
   else
     self.marker:Hide()
   end

Display/CastIconMarker.lua

@@ -5,7 +5,7 @@ local borderPool = CreateTexturePool(UIParent, "BACKGROUND", 0, nil, function(_,
   tex:SetColorTexture(0, 0, 0)
 end)
 
-addonTable.Display.CastIconMarkerMixin = {}
+addonTable.Display.CastIconMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.CastIconMarkerMixin:PostInit()
   if self.details.square then
@@ -33,6 +33,8 @@ function addonTable.Display.CastIconMarkerMixin:SetUnit(unit)
     self:RegisterUnitEvent("UNIT_SPELLCAST_INTERRUPTED", self.unit)
     self:RegisterUnitEvent("UNIT_SPELLCAST_FAILED", self.unit)
 
+    self:RegisterCombatEvents()
+
     self:ApplyCasting()
   else
     self:UnregisterAllEvents()
@@ -56,6 +58,12 @@ function addonTable.Display.CastIconMarkerMixin:OnEvent(eventName, ...)
     if self.background then
       self.background:Show()
     end
+    if self:ShouldHideForCombat() then
+      self.marker:Hide()
+      if self.background then
+        self.background:Hide()
+      end
+    end
     self.timer = C_Timer.NewTimer(0.8, function()
       if self.interrupted then
         self.interrupted = nil
@@ -65,6 +73,8 @@ function addonTable.Display.CastIconMarkerMixin:OnEvent(eventName, ...)
         end
       end
     end)
+  elseif eventName == "PLAYER_REGEN_ENABLED" or eventName == "PLAYER_REGEN_DISABLED" then
+    self:ApplyCasting()
   else
     self:ApplyCasting()
   end
@@ -82,6 +92,12 @@ function addonTable.Display.CastIconMarkerMixin:ApplyCasting()
     if self.background then
       self.background:Show()
     end
+    if self:ShouldHideForCombat() then
+      self.marker:Hide()
+      if self.background then
+        self.background:Hide()
+      end
+    end
   elseif not self.interrupted then
     self.marker:Hide()
     if self.background then

Display/EliteMarker.lua

@@ -1,7 +1,7 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.EliteMarkerMixin = {}
+addonTable.Display.EliteMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.EliteMarkerMixin:PostInit()
   local markerDetails = addonTable.Assets.Markers[self.details.asset]
@@ -15,24 +15,41 @@ function addonTable.Display.EliteMarkerMixin:PostInit()
   end
 end
 
+function addonTable.Display.EliteMarkerMixin:Update()
+  local classification = UnitClassification(self.unit)
+  if classification == "elite" or classification == "worldboss" then
+    self.marker:Show()
+    self.marker:SetTexture(self.eliteTexture)
+  elseif classification == "rareelite" then
+    self.marker:Show()
+    self.marker:SetTexture(self.rareEliteTexture)
+  else
+    self.marker:Hide()
+    return
+  end
+
+  if self:ShouldHideForCombat() then
+    self.marker:Hide()
+  end
+end
+
 function addonTable.Display.EliteMarkerMixin:SetUnit(unit)
   self.unit = unit
+  self:UnregisterAllEvents()
   if self.unit then
-    local classification = UnitClassification(self.unit)
-    if classification == "elite" or classification == "worldboss" then
-      self.marker:Show()
-      self.marker:SetTexture(self.eliteTexture)
-    elseif classification == "rareelite" then
-      self.marker:Show()
-      self.marker:SetTexture(self.rareEliteTexture)
-    else
-      self.marker:Hide()
-    end
+    self:RegisterCombatEvents()
+    self:Update()
   else
     self:Strip()
   end
 end
 
+function addonTable.Display.EliteMarkerMixin:OnEvent(event)
+  if event == "PLAYER_REGEN_ENABLED" or event == "PLAYER_REGEN_DISABLED" then
+    self:Update()
+  end
+end
+
 function addonTable.Display.EliteMarkerMixin:Strip()
   self:UnregisterAllEvents()
 end

Display/PvPMarker.lua

@@ -1,12 +1,13 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.PvPMarkerMixin = {}
+addonTable.Display.PvPMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.PvPMarkerMixin:SetUnit(unit)
   self.unit = unit
   if self.unit and addonTable.Constants.IsRetail then
     self:RegisterUnitEvent("UNIT_CLASSIFICATION_CHANGED", self.unit)
+    self:RegisterCombatEvents()
 
     self.showClassification = C_PvP.IsPVPMap()
 
@@ -53,6 +54,9 @@ function addonTable.Display.PvPMarkerMixin:Update()
   if atlas then
     self.marker:Show()
     self.marker:SetAtlas(atlas)
+    if self:ShouldHideForCombat() then
+      self.marker:Hide()
+    end
   else
     self.marker:Hide()
   end

Display/QuestMarker.lua

@@ -1,12 +1,13 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.QuestMarkerMixin = {}
+addonTable.Display.QuestMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.QuestMarkerMixin:SetUnit(unit)
   self.unit = unit
   if self.unit then
     self:RegisterEvent("QUEST_LOG_UPDATE")
+    self:RegisterCombatEvents()
     self:UpdateMarker()
   else
     self:Strip()
@@ -19,8 +20,15 @@ end
 
 function addonTable.Display.QuestMarkerMixin:UpdateMarker()
   self.marker:SetShown(C_QuestLog.UnitIsRelatedToActiveQuest and C_QuestLog.UnitIsRelatedToActiveQuest(self.unit))
+  if self:ShouldHideForCombat() then
+    self.marker:Hide()
+  end
 end
 
 function addonTable.Display.QuestMarkerMixin:OnEvent(eventName, ...)
-  self:UpdateMarker()
+  if eventName == "PLAYER_REGEN_ENABLED" or eventName == "PLAYER_REGEN_DISABLED" then
+    self:UpdateMarker()
+  else
+    self:UpdateMarker()
+  end
 end

Display/RaidMarker.lua

@@ -1,12 +1,13 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.RaidMarkerMixin = {}
+addonTable.Display.RaidMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.RaidMarkerMixin:SetUnit(unit)
   self.unit = unit
   if self.unit then
     self:RegisterEvent("RAID_TARGET_UPDATE")
+    self:RegisterCombatEvents()
     self:UpdateMarker()
   else
     self:Strip()
@@ -18,8 +19,12 @@ function addonTable.Display.RaidMarkerMixin:Strip()
   self.marker:SetTexCoord(0, 1, 0, 1)
 end
 
-function addonTable.Display.RaidMarkerMixin:OnEvent()
-  self:UpdateMarker()
+function addonTable.Display.RaidMarkerMixin:OnEvent(eventName)
+  if eventName == "PLAYER_REGEN_ENABLED" or eventName == "PLAYER_REGEN_DISABLED" then
+    self:UpdateMarker()
+  else
+    self:UpdateMarker()
+  end
 end
 
 local fontString = UIParent:CreateFontString(nil, nil, "GameFontNormal")
@@ -29,6 +34,9 @@ function addonTable.Display.RaidMarkerMixin:UpdateMarker()
   if type(index) ~= "nil" then
     self.marker:Show()
     SetRaidTargetIconTexture(self.marker, index)
+    if self:ShouldHideForCombat() then
+      self.marker:Hide()
+    end
   else
     self.marker:Hide()
   end

Display/RareMarker.lua

@@ -1,19 +1,34 @@
 ---@class addonTablePlatynator
 local addonTable = select(2, ...)
 
-addonTable.Display.RareMarkerMixin = {}
+addonTable.Display.RareMarkerMixin = CreateFromMixins(addonTable.Display.CombatVisibilityMixin)
 
 function addonTable.Display.RareMarkerMixin:SetUnit(unit)
   self.unit = unit
+  self:UnregisterAllEvents()
   if self.unit then
-    local classification = UnitClassification(self.unit)
-    if classification == "rare" then
-      self.marker:Show()
-    else
+    self:RegisterCombatEvents()
+    self:Update()
+  else
+    self:Strip()
+  end
+end
+
+function addonTable.Display.RareMarkerMixin:OnEvent(eventName)
+  if eventName == "PLAYER_REGEN_ENABLED" or eventName == "PLAYER_REGEN_DISABLED" then
+    self:Update()
+  end
+end
+
+function addonTable.Display.RareMarkerMixin:Update()
+  local classification = UnitClassification(self.unit)
+  if classification == "rare" then
+    self.marker:Show()
+    if self:ShouldHideForCombat() then
       self.marker:Hide()
     end
   else
-    self:Strip()
+    self.marker:Hide()
   end
 end
 

Display/Utilities.lua

@@ -66,3 +66,20 @@ function addonTable.Display.Utilities.IsInRelevantInstance()
   local _, instanceType = GetInstanceInfo()
   return instanceType == "raid" or instanceType == "party" or instanceType == "arenas"
 end
+
+addonTable.Display.CombatVisibilityMixin = {}
+
+function addonTable.Display.CombatVisibilityMixin:RegisterCombatEvents()
+  if self.details.combatState and self.details.combatState ~= "Never" then
+    self:RegisterEvent("PLAYER_REGEN_DISABLED")
+    self:RegisterEvent("PLAYER_REGEN_ENABLED")
+  end
+end
+
+function addonTable.Display.CombatVisibilityMixin:ShouldHideForCombat()
+  local inCombat = UnitAffectingCombat("player")
+  if self.details.combatState == "Always" and inCombat then
+    return true
+  end
+  return false
+end

Locales.lua

@@ -229,6 +229,10 @@ L["IMPORTANT_CAST"] = "Important Cast"
 L["INTERRUPTED_CAST"] = "Interrupted cast"
 L["UNINTERRUPTABLE"] = "Uninterruptable"
 
+L["HIDE_IN_COMBAT"] = "Hide in combat"
+L["ALWAYS"] = "Always"
+L["NEVER"] = "Never"
+
 L["WHAT_TO_EXPORT"] = "What to export?"
 L["STYLE"] = "Style"
 L["PROFILE"] = "Profile"