[Add] Add BuffEffectProcessor (#173)

* Update SplatoonScripts/update.csv * [add] add TestScript * [add] NewScriptEventHandler * [clean] Trans English * Update SplatoonScripts/update.csv * [clean] Removed unnecessary log output. --------- Co-authored-by: GitHub Action <[email protected]>
PunishXIV · Sep 22, 2024 · d3cb9cc · d3cb9cc
1 parent 55228c2
commit d3cb9cc
Show file tree

Hide file tree

Showing 9 changed files with 701 additions and 70 deletions.
diff --git a/Splatoon/Memory/BuffEffectProcessor.cs b/Splatoon/Memory/BuffEffectProcessor.cs
@@ -0,0 +1,290 @@
+using Dalamud.Game.ClientState.Statuses;
+using ECommons.Hooks;
+using Splatoon.SplatoonScripting;
+
+namespace Splatoon.Memory;
+internal class BuffEffectProcessor
+{
+    #region types
+    private enum StatusChangeType
+    {
+        NoChange,
+        Remove,
+        Gain
+    }
+
+    private enum StatusChangeResult
+    {
+        NoChange,
+        Change
+    }
+
+    private struct CharactorStatusInfo
+    {
+        public uint ObjectID;
+        public uint[] StatusIds;
+        public int NoUpdateCount;
+    }
+
+    private struct CharactorStatusDiffResult
+    {
+        public uint StatusId;
+        public StatusChangeType ChangeType;
+    }
+    #endregion
+
+    #region privateDefine
+    private Dictionary<uint, CharactorStatusInfo> _charactorStatusInfos = new Dictionary<uint, CharactorStatusInfo>();
+    private static bool _isClearRequest = false;
+    #endregion
+
+    #region public
+    public void ActorEffectUpdate()
+    {
+        if(_isClearRequest)
+        {
+            _charactorStatusInfos.Clear();
+            _isClearRequest = false;
+        }
+
+        // Increment the NoUpdateCount for all objects
+        IncrementNoUpdateCount();
+
+        // Loop through all objects in Svc.Objects
+        foreach(var gameObject in Svc.Objects)
+        {
+            if(gameObject == null)
+                continue;
+
+            // Check if it can be cast to IBattleChara
+            if(gameObject is IBattleChara battleChara)
+            {
+                var objectID = battleChara.EntityId;
+
+                // If the object exists, reset the counter
+                if(_charactorStatusInfos.TryGetValue(objectID, out var statusInfo))
+                {
+                    statusInfo.NoUpdateCount = 0; // Reset the counter as the object is confirmed to exist
+                    _charactorStatusInfos[objectID] = statusInfo;
+                }
+
+                var statuses = battleChara.StatusList;
+
+                // Compare the current and previous status lists
+                CompareStatusList(objectID, statuses, out var changeStatuses);
+
+                // Log the changes, including gameObject.Name
+                LogChanges(battleChara, changeStatuses);
+
+                // Save the current status list
+                CopyStatusList(objectID, statuses);
+            }
+        }
+
+        // Remove objects that have not been updated for 10 cycles
+        RemoveInactiveObjects();
+    }
+
+    public static void DirectorCheck(DirectorUpdateCategory category)
+    {
+        if(category == DirectorUpdateCategory.Commence ||
+            category == DirectorUpdateCategory.Wipe)
+        {
+            _isClearRequest = true;
+        }
+    }
+    #endregion
+
+    #region private
+    private void IncrementNoUpdateCount()
+    {
+        // Increment the NoUpdateCount for all objects
+        foreach(var key in _charactorStatusInfos.Keys)
+        {
+            var statusInfo = _charactorStatusInfos[key];
+            statusInfo.NoUpdateCount++;
+            _charactorStatusInfos[key] = statusInfo;
+        }
+    }
+
+    private void RemoveInactiveObjects()
+    {
+        // Add objects with NoUpdateCount >= 10 to the removal list
+        List<uint> toRemove = new List<uint>();
+        foreach(var kvp in _charactorStatusInfos)
+        {
+            if(kvp.Value.NoUpdateCount >= 10)
+            {
+                toRemove.Add(kvp.Key);
+            }
+        }
+
+        // Actually remove the objects
+        foreach(var objectID in toRemove)
+        {
+            _charactorStatusInfos.Remove(objectID);
+        }
+    }
+
+    private void CopyStatusList(uint objectID, StatusList statuses)
+    {
+        var newStatusIds = GetStatusIds(statuses);
+
+        if(_charactorStatusInfos.TryGetValue(objectID, out var existingInfo))
+        {
+            if(!ArraysEqual(existingInfo.StatusIds, newStatusIds))
+            {
+                _charactorStatusInfos[objectID] = new CharactorStatusInfo
+                {
+                    ObjectID = objectID,
+                    StatusIds = newStatusIds,
+                    NoUpdateCount = 0 // Reset the counter as it has been updated
+                };
+            }
+        }
+        else
+        {
+            _charactorStatusInfos.Add(objectID, new CharactorStatusInfo
+            {
+                ObjectID = objectID,
+                StatusIds = newStatusIds,
+                NoUpdateCount = 0 // Set the counter to 0 when adding a new object
+            });
+        }
+    }
+
+    private StatusChangeResult CompareStatusList(uint objectID, StatusList statuses, out List<CharactorStatusDiffResult> changeStatuses)
+    {
+        changeStatuses = new List<CharactorStatusDiffResult>();
+
+        if(!_charactorStatusInfos.TryGetValue(objectID, out var existingInfo))
+        {
+            return StatusChangeResult.NoChange;
+        }
+
+        var currentStatusIds = GetStatusIds(statuses);
+
+        CheckGains(currentStatusIds, existingInfo.StatusIds, changeStatuses);
+        CheckRemovals(currentStatusIds, existingInfo.StatusIds, changeStatuses);
+
+        return changeStatuses.Count > 0 ? StatusChangeResult.Change : StatusChangeResult.NoChange;
+    }
+
+    private uint[] GetStatusIds(StatusList statuses)
+    {
+        var statusIds = new uint[statuses.Length];
+        for(int i = 0; i < statuses.Length; i++)
+        {
+            statusIds[i] = statuses[i]?.StatusId ?? 0;
+        }
+        return statusIds;
+    }
+
+    private void CheckGains(uint[] currentStatusIds, uint[] oldStatusIds, List<CharactorStatusDiffResult> changeStatuses)
+    {
+        for(int i = 0; i < currentStatusIds.Length; i++)
+        {
+            if(System.Array.IndexOf(oldStatusIds, currentStatusIds[i]) < 0)
+            {
+                changeStatuses.Add(new CharactorStatusDiffResult
+                {
+                    StatusId = currentStatusIds[i],
+                    ChangeType = StatusChangeType.Gain
+                });
+            }
+        }
+    }
+
+    private void CheckRemovals(uint[] currentStatusIds, uint[] oldStatusIds, List<CharactorStatusDiffResult> changeStatuses)
+    {
+        for(int i = 0; i < oldStatusIds.Length; i++)
+        {
+            if(System.Array.IndexOf(currentStatusIds, oldStatusIds[i]) < 0)
+            {
+                changeStatuses.Add(new CharactorStatusDiffResult
+                {
+                    StatusId = oldStatusIds[i],
+                    ChangeType = StatusChangeType.Remove
+                });
+            }
+        }
+    }
+
+    private bool ArraysEqual(uint[] array1, uint[] array2)
+    {
+        if(array1.Length != array2.Length)
+            return false;
+
+        for(int i = 0; i < array1.Length; i++)
+        {
+            if(array1[i] != array2[i])
+                return false;
+        }
+        return true;
+    }
+
+    // Updated LogChanges method
+    private void LogChanges(IBattleChara battleChara, List<CharactorStatusDiffResult> changeStatuses)
+    {
+        List<uint> gainStatusIds = new List<uint>();
+        List<uint> removeStatusIds = new List<uint>();
+
+        foreach(var changeStatus in changeStatuses)
+        {
+            switch(changeStatus.ChangeType)
+            {
+                case StatusChangeType.Gain:
+                gainStatusIds.Add(changeStatus.StatusId);
+                break;
+                case StatusChangeType.Remove:
+                removeStatusIds.Add(changeStatus.StatusId);
+                break;
+            }
+        }
+
+        if(gainStatusIds.Count > 0)
+        {
+            string text;
+            if(P.Config.LogPosition)
+            {
+                foreach(var statusId in gainStatusIds)
+                {
+                    text = $"{battleChara.Name} ({battleChara.Position.ToString()}) gains the effect of {statusId} ({battleChara.NameId}:+{statusId})";
+                    P.ChatMessageQueue.Enqueue(text);
+                }
+            }
+            else
+            {
+                foreach(var statusId in gainStatusIds)
+                {
+                    text = $"{battleChara.Name} gains the effect of {statusId} ({battleChara.NameId}:+{statusId})";
+                    P.ChatMessageQueue.Enqueue(text);
+                }
+            }
+            ScriptingProcessor.OnGainBuffEffect(battleChara.EntityId, gainStatusIds);
+        }
+
+        if(removeStatusIds.Count > 0)
+        {
+            string text;
+            if(P.Config.LogPosition)
+            {
+                foreach(var statusId in removeStatusIds)
+                {
+                    text = $"{battleChara.Name} ({battleChara.Position.ToString()}) loses the effect of {statusId} ({battleChara.NameId}:-{statusId})";
+                    P.ChatMessageQueue.Enqueue(text);
+                }
+            }
+            else
+            {
+                foreach(var statusId in removeStatusIds)
+                {
+                    text = $"{battleChara.Name} loses the effect of {statusId} ({battleChara.NameId}:-{statusId})";
+                    P.ChatMessageQueue.Enqueue(text);
+                }
+            }
+            ScriptingProcessor.OnRemoveBuffEffect(battleChara.EntityId, removeStatusIds);
+        }
+    }
+    #endregion
+}
diff --git a/Splatoon/Memory/DirectorUpdateProcessor.cs b/Splatoon/Memory/DirectorUpdateProcessor.cs
@@ -23,6 +23,7 @@ internal static void ProcessDirectorUpdate(long a1, long a2, DirectorUpdateCateg
                 Logger.Log(text);
                 PluginLog.Verbose(text);
             }
+            BuffEffectProcessor.DirectorCheck(a3);
             ScriptingProcessor.OnDirectorUpdate(a3);
         }
     }

diff --git a/Splatoon/Splatoon.cs b/Splatoon/Splatoon.cs
@@ -83,6 +83,7 @@ public unsafe class Splatoon : IDalamudPlugin
     public NotificationMasterApi NotificationMasterApi;
     public Archive Archive;
     private ActorControlProcessor ActorControlProcessor;
+    internal BuffEffectProcessor BuffEffectProcessor;
 
     internal void Load(IDalamudPluginInterface pluginInterface)
     {
@@ -187,6 +188,7 @@ internal void Load(IDalamudPluginInterface pluginInterface)
         SingletonServiceManager.Initialize(typeof(S));
         Archive = EzConfig.LoadConfiguration<Archive>("Archive.json");
         ActorControlProcessor = new ActorControlProcessor();
+        BuffEffectProcessor = new();
         Init = true;
         SplatoonIPC.Init();
     }
@@ -557,6 +559,7 @@ internal void Tick(IFramework framework)
             }
             prevCombatState = Svc.Condition[ConditionFlag.InCombat];
             CurrentChatMessages.Clear();
+            BuffEffectProcessor.ActorEffectUpdate();
             ScriptingProcessor.OnUpdate();
         }
         catch (Exception e)

diff --git a/Splatoon/SplatoonScripting/ScriptingProcessor.cs b/Splatoon/SplatoonScripting/ScriptingProcessor.cs
@@ -630,6 +630,36 @@ internal static void OnActionEffectEvent(ActionEffectSet set)
         }
     }
 
+    internal static void OnGainBuffEffect(uint sourceId, List<uint> gainBuffIds)
+    {
+        for(var i = 0; i < Scripts.Count; i++)
+        {
+            if(Scripts[i].IsEnabled)
+            {
+                try
+                {
+                    Scripts[i].OnGainBuffEffect(sourceId, gainBuffIds);
+                }
+                catch(Exception e) { Scripts[i].LogError(e, nameof(SplatoonScript.OnGainBuffEffect)); }
+            }
+        }
+    }
+
+    internal static void OnRemoveBuffEffect(uint sourceId, List<uint> removeBuffIds)
+    {
+        for(var i = 0; i < Scripts.Count; i++)
+        {
+            if(Scripts[i].IsEnabled)
+            {
+                try
+                {
+                    Scripts[i].OnRemoveBuffEffect(sourceId, removeBuffIds);
+                }
+                catch(Exception e) { Scripts[i].LogError(e, nameof(SplatoonScript.OnRemoveBuffEffect)); }
+            }
+        }
+    }
+
     internal static void TerritoryChanged()
     {
         for (var i = 0; i < Scripts.Count; i++)