Add option to hide overlays outside combat

Author: ngld

OverlayPlugin.Common/IOverlayConfig.cs

@@ -21,6 +21,7 @@ public interface IOverlayConfig
         string Name { get; set; }
         bool IsVisible { get; set; }
         bool IsClickThru { get; set; }
+        bool HideOutOfCombat { get; set; }
         Point Position { get; set; }
         Size Size { get; set; }
         string Url { get; set; }

OverlayPlugin.Core/Controls/WSConfigPanel.cs

@@ -69,10 +69,6 @@ public WSConfigPanel(TinyIoCContainer container)
             UpdateTunnelStatus(TunnelStatus.Inactive);
 
             lblUrlConfidentWarning.Visible = false;
-            container.Resolve<PluginMain>().OverlaysChanged += (o, e) =>
-            {
-                RebuildOverlayOptions();
-            };
         }
 
         public void Stop()
@@ -316,7 +312,7 @@ private void ipTxt_Leave(object sender, EventArgs e)
             }
         }
 
-        private void RebuildOverlayOptions()
+        public void RebuildOverlayOptions()
         {
             cbOverlay.Items.Clear();
 

OverlayPlugin.Core/EventSources/EnmityEventSource.cs

@@ -151,6 +151,11 @@ protected override void Update()
 
                 // Handle optional "end encounter of combat" logic.
                 bool inGameCombat = memory.GetInCombat();
+                if (inGameCombat != lastInGameCombat)
+                {
+                    logger.Log(LogLevel.Debug, inGameCombat ? "Entered combat" : "Left combat");
+                }
+
                 // If we've transitioned to being out of combat, start a delayed task to end the ACT encounter.
                 if (Config.EndEncounterOutOfCombat && lastInGameCombat && !inGameCombat)
                 {

OverlayPlugin.Core/EventSources/MiniParseEventSource.cs

@@ -664,15 +664,9 @@ internal JObject CreateCombatData()
             Dictionary<string, string> encounter = null;
             List<KeyValuePair<CombatantData, Dictionary<string, string>>> combatant = null;
 
-            var encounterTask = Task.Run(() =>
-            {
-                encounter = GetEncounterDictionary(allies);
-            });
-            var combatantTask = Task.Run(() =>
-            {
-                combatant = GetCombatantList(allies);
-            });
-            Task.WaitAll(encounterTask, combatantTask);
+            
+            encounter = GetEncounterDictionary(allies);
+            combatant = GetCombatantList(allies);
 
             if (encounter == null || combatant == null) return new JObject();
 

OverlayPlugin.Core/OverlayConfigBase.cs

@@ -18,6 +18,7 @@ public abstract class OverlayConfigBase : IOverlayConfig
         public event EventHandler GlobalHotkeyChanged;
         public event EventHandler<LockStateChangedEventArgs> LockChanged;
         public event EventHandler LogConsoleMessagesChanged;
+        public event EventHandler HideOutOfCombatChanged;
 
         public string Name { get; set; }
 
@@ -203,6 +204,23 @@ public bool LogConsoleMessages
             }
         }
 
+        private bool hideOutOfCombat = false;
+        public bool HideOutOfCombat
+        {
+            get
+            {
+                return this.hideOutOfCombat;
+            }
+            set
+            {
+                if (this.hideOutOfCombat != value)
+                {
+                    this.hideOutOfCombat = value;
+                    HideOutOfCombatChanged?.Invoke(this, new EventArgs());
+                }
+            }
+        }
+
         protected OverlayConfigBase(string name)
         {
             this.Name = name;

OverlayPlugin.Core/OverlayHider.cs

@@ -14,6 +14,7 @@ class OverlayHider
     {
         private bool gameActive = true;
         private bool inCutscene = false;
+        private bool inCombat = false;
         private IPluginConfig config;
         private ILogger logger;
         private PluginMain main;
@@ -30,6 +31,7 @@ public OverlayHider(TinyIoCContainer container)
 
             container.Resolve<NativeMethods>().ActiveWindowChanged += ActiveWindowChangedHandler;
             container.Resolve<NetworkParser>().OnOnlineStatusChanged += OnlineStatusChanged;
+            container.Resolve<EventSources.EnmityEventSource>().CombatStatusChanged += CombatStatusChanged;
             repository.RegisterProcessChangedHandler(UpdateFFXIVProcess);
 
             focusTimer = new Timer();
@@ -61,7 +63,10 @@ public void UpdateOverlays()
             {
                 foreach (var overlay in main.Overlays)
                 {
-                    if (overlay.Config.IsVisible) overlay.Visible = gameActive && !inCutscene;
+                    if (overlay.Config.IsVisible)
+                    {
+                        overlay.Visible = gameActive && !inCutscene && (!overlay.Config.HideOutOfCombat || inCombat);
+                    }
                 }
             } catch (Exception ex)
             {
@@ -121,5 +126,11 @@ private void OnlineStatusChanged(object sender, OnlineStatusChangedArgs e)
             inCutscene = e.Status == 15;
             UpdateOverlays();
         }
+
+        private void CombatStatusChanged(object sender, EventSources.CombatStatusChangedArgs e)
+        {
+            inCombat = e.InCombat;
+            UpdateOverlays();
+        }
     }
 }