Hotfix: SIT GC

Source/Configuration/PluginConfigSettings.cs

@@ -38,37 +38,34 @@ public void GetSettings()
 
         }
 
+        internal sealed class ConfigurationManagerAttributes
+        {
+            public bool? IsAdvanced = false;
+            public bool? ShowRangeAsPercent;
+        }
+
         public class SITAdvancedSettings
         {
             public const string Advanced = "Advanced";
             public ConfigFile Config { get; }
             public ManualLogSource Logger { get; }
 
-            public bool SETTING_EnableSITGC
-            {
-                get
-                {
-                    return StayInTarkovPlugin.Instance.Config.Bind
-                       (Advanced, "EnableSITGC", false, new ConfigDescription("Enable SIT's own Garbage Collector")).Value;
-                }
-            }
-
-            public uint SETTING_SITGCMemoryThreshold
-            {
-                get
-                {
-                    return StayInTarkovPlugin.Instance.Config.Bind
-                       (Advanced, "SITGCMemoryThreshold", 90u, new ConfigDescription("SIT's Garbage Collector. System Memory % before SIT forces a Garbage Collection.")).Value;
-                }
-            }
+            public bool SETTING_EnableSITGC { get; set; }
 
+            public uint SETTING_SITGCMemoryThreshold { get; set; }
+            public uint SETTING_SITGCMemoryCheckTime { get; set; }
 
             public SITAdvancedSettings(ManualLogSource logger, ConfigFile config)
             {
                 Logger = logger;
                 Config = config;
-                _ = SETTING_EnableSITGC;
-                _ = SETTING_SITGCMemoryThreshold;
+                SETTING_EnableSITGC = StayInTarkovPlugin.Instance.Config.Bind
+                       (Advanced, "EnableSITGC", false, new ConfigDescription("Enable SIT's own Garbage Collector")).Value;
+                SETTING_SITGCMemoryThreshold = StayInTarkovPlugin.Instance.Config.Bind
+                       (Advanced, "SITGCMemoryThreshold", 90u, new ConfigDescription("System Memory usage % limit, above that, SIT forces the run of Garbage Collection.", new AcceptableValueRange<uint>(50u, 95u), new ConfigurationManagerAttributes { IsAdvanced = true, ShowRangeAsPercent = true })).Value;
+                SETTING_SITGCMemoryCheckTime = StayInTarkovPlugin.Instance.Config.Bind
+                       (Advanced, "SITGCMemoryCheckTime", 300u, new ConfigDescription("Set how many seconds to wait between SIT's Garbage Collector checks.", new AcceptableValueRange<uint>(60u, 900u), new ConfigurationManagerAttributes { IsAdvanced = true })).Value;
+
             }
 
         }

Source/Coop/Components/CoopGameComponents/SITGameComponent.cs

@@ -124,7 +124,7 @@
 
         public bool RunAsyncTasks { get; set; } = true;
 
         float screenScale = 1.0f;
 
         Camera GameCamera { get; set; }
 
@@ -331,8 +331,7 @@
             //    CoopSITGame.SendPlayerDataToServer((LocalPlayer)Singleton<GameWorld>.Instance.RegisteredPlayers.First(x => x.IsYourPlayer));
             //}
 
-            GarbageCollect();
-            StartCoroutine(GarbageCollectSIT());
+            this.GetOrAddComponent<SITGameGCComponent>();
 
             StartCoroutine(SendPlayerStatePacket());
 
@@ -358,58 +357,7 @@
             ListOfInteractiveObjects = FindObjectsOfType<WorldInteractiveObject>();
         }
 
-        private void GarbageCollect()
-        {
-            // Start the SIT Garbage Collector
-            Logger.LogDebug($"{nameof(GarbageCollect)}");   
-            BSGMemoryGC.RunHeapPreAllocation();
-            BSGMemoryGC.Collect(force: true);
-            BSGMemoryGC.EmptyWorkingSet();
-            BSGMemoryGC.GCEnabled = true;
-            //Resources.UnloadUnusedAssets();
-        }
-
-        /// <summary>
-        /// Runs the Garbage Collection every 5 minutes
-        /// </summary>
-        /// <returns></returns>
-        private IEnumerator GarbageCollectSIT()
-        {
-            while(true)
-            {
-                if (PluginConfigSettings.Instance.AdvancedSettings.SETTING_EnableSITGC)
-                {
-                    var nearestEnemyDist = float.MaxValue;
-                    foreach(var p in Players)
-                    {
-                        if (p.Key == Singleton<GameWorld>.Instance.MainPlayer.ProfileId)
-                            continue;
-
-                        var dist = Vector3.Distance(p.Value.Transform.position, Singleton<GameWorld>.Instance.MainPlayer.Transform.position);
-                        if(dist < nearestEnemyDist)
-                            nearestEnemyDist = dist;
-                    }
-
-                    if (nearestEnemyDist > 10)
-                    {
-                        var mem = MemoryInfo.GetCurrentStatus();
-                        if (mem == null)
-                        {
-                            yield return new WaitForSeconds(1);
-                            continue;
-                        }
-
-                        var memPercentInUse = mem.dwMemoryLoad;
-                        Logger.LogDebug($"Total memory used: {mem.dwMemoryLoad}%");
-                        if (memPercentInUse > PluginConfigSettings.Instance.AdvancedSettings.SETTING_SITGCMemoryThreshold)
-                            GarbageCollect();
-
-                    }
-                }
-
-                yield return new WaitForSeconds(60);
-            }
-        }
+
 
         /// <summary>
         /// This is a simple coroutine to allow methods to run every second.
@@ -595,6 +543,7 @@
             StopCoroutine(EverySecondCoroutine());
 
             CoopPatches.EnableDisablePatches();
+            GameObject.Destroy(this.GetComponent<SITGameGCComponent>());
         }
 
         TimeSpan LateUpdateSpan = TimeSpan.Zero;

Source/Coop/Components/CoopGameComponents/SITGameGCComponent.cs

@@ -0,0 +1,102 @@
+using Comfort.Common;
+using EFT;
+using StayInTarkov.Configuration;
+using StayInTarkov.Memory;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using UnityEngine;
+
+namespace StayInTarkov.Coop.Components.CoopGameComponents
+{
+    public sealed class SITGameGCComponent : MonoBehaviour
+    {
+        private DateTime LastTimeRun { get; set; } = DateTime.MinValue;
+        private BepInEx.Logging.ManualLogSource Logger { get; set; }
+
+        private int LastNumberOfPlayers { get; set; }
+
+        private int NumberOfAlivePlayers => Singleton<GameWorld>.Instance.AllAlivePlayersList.Count;
+
+        #region Unity methods
+
+        void Awake()
+        {
+            Logger = BepInEx.Logging.Logger.CreateLogSource(nameof(SITGameGCComponent));
+            Logger.LogDebug($"{nameof(SITGameGCComponent)}:{nameof(Awake)}");
+        }
+
+        void Start()
+        {
+            Logger.LogDebug($"{nameof(SITGameGCComponent)}:{nameof(Start)}");
+            GarbageCollect();
+        }
+
+        void Update()
+        {
+            if((DateTime.Now - LastTimeRun).TotalSeconds > PluginConfigSettings.Instance.AdvancedSettings.SETTING_SITGCMemoryCheckTime)
+            {
+                LastTimeRun = DateTime.Now;
+                GarbageCollectSIT();
+            }
+
+            if (NumberOfAlivePlayers != LastNumberOfPlayers)
+            {
+                LastNumberOfPlayers = NumberOfAlivePlayers;
+                BSGMemoryGC.Collect(force: false);
+            }
+        }
+
+        #endregion
+
+        private void GarbageCollect()
+        {
+            Logger.LogDebug($"{nameof(GarbageCollect)}");
+            BSGMemoryGC.RunHeapPreAllocation();
+            BSGMemoryGC.Collect(force: true);
+            BSGMemoryGC.EmptyWorkingSet();
+            BSGMemoryGC.GCEnabled = true;
+            Resources.UnloadUnusedAssets();
+        }
+
+        /// <summary>
+        /// Runs the Garbage Collection
+        /// </summary>
+        /// <returns></returns>
+        private void GarbageCollectSIT()
+        {
+            if (!PluginConfigSettings.Instance.AdvancedSettings.SETTING_EnableSITGC)
+                return;
+
+            var nearestEnemyDist = float.MaxValue;
+            foreach (var p in Singleton<GameWorld>.Instance.AllAlivePlayersList)
+            {
+                if (p.ProfileId == Singleton<GameWorld>.Instance.MainPlayer.ProfileId)
+                    continue;
+
+                var dist = Vector3.Distance(p.Transform.position, Singleton<GameWorld>.Instance.MainPlayer.Transform.position);
+                if (dist < nearestEnemyDist)
+                    nearestEnemyDist = dist;
+            }
+
+            if (nearestEnemyDist > 10)
+            {
+                var mem = MemoryInfo.GetCurrentStatus();
+                if (mem == null)
+                {
+                    return;
+                }
+
+                var memPercentInUse = mem.dwMemoryLoad;
+                Logger.LogDebug($"Total memory used: {mem.dwMemoryLoad}%");
+                if (memPercentInUse > PluginConfigSettings.Instance.AdvancedSettings.SETTING_SITGCMemoryThreshold)
+                    GarbageCollect();
+
+            }
+        }
+
+    }
+}