Implement animation effects for various tools

SSMP/Animation/AnimationClip.cs

@@ -768,4 +768,9 @@ internal enum AnimationClip {
     WitchTentacles,
     ShamanCancel,
     BindInterrupt,
+    MagnetiteDice,
+    FleaBrew,
+    FracturedMask,
+    MagmaBell,
+    Bench
 }

SSMP/Animation/AnimationEffect.cs

@@ -1,5 +1,6 @@
 using SSMP.Game.Settings;
 using SSMP.Internals;
+using SSMP.Util;
 using UnityEngine;
 
 namespace SSMP.Animation;
@@ -25,7 +26,7 @@ public void SetServerSettings(ServerSettings serverSettings) {
     }
 
     /// <summary>
-    /// Locate the damages_enemy FSM and change the attack direction to the given direciton. This will ensure that
+    /// Locate the damages_enemy FSM and change the attack direction to the given direction. This will ensure that
     /// enemies are getting knocked back in the correct direction from remote player's attacks.
     /// </summary>
     /// <param name="targetObject">The target GameObject to change.</param>
@@ -52,4 +53,54 @@ protected static void HidePlayer(GameObject playerObject) {
         playerObject.GetComponent<tk2dSpriteAnimator>().Stop();
         playerObject.GetComponent<tk2dSprite>().SetSprite("wall_puff0004");
     }
+
+    /// <summary>
+    /// Gets the Effects object for a given player object. If the player object does not have an Effects object, it
+    /// will be created.
+    /// </summary>
+    /// <param name="playerObject">The player object for the player using the effect.</param>
+    /// <returns>The player's effects object.</returns>
+    protected static GameObject GetPlayerEffects(GameObject playerObject) {
+        var effects = playerObject.FindGameObjectInChildren("Effects");
+        if (effects == null) {
+            effects = new GameObject("Effects");
+            effects.transform.SetParentReset(playerObject.transform);
+        }
+
+        return effects;
+    }
+
+    /// <summary>
+    /// Attempts to get or create an effect from the Effects sub-object.
+    /// </summary>
+    /// <param name="playerObject">The player object for the player using the effect.</param>
+    /// <param name="effectName">The name of the effect object.</param>
+    /// <param name="effect">The effect, if found or created.</param>
+    /// <returns>True if created, false otherwise.</returns>
+    protected static bool TryGetEffect(GameObject playerObject, string effectName, out GameObject? effect) {
+        // Find or create effects for player
+        var effects = GetPlayerEffects(playerObject);
+
+        // Find existing effect
+        effect = effects.FindGameObjectInChildren(effectName);
+        if (effect != null) {
+            return false;
+        }
+
+        // Create new effect
+        var localEffects = HeroController.instance.gameObject.FindGameObjectInChildren("Effects");
+        if (localEffects == null) {
+            return false;
+        }
+
+        var localEffect = localEffects.FindGameObjectInChildren(effectName);
+        if (localEffect == null) {
+            return false;
+        }
+
+        effect = Object.Instantiate(localEffect, effects.transform);
+        effect.name = effectName;
+
+        return true;
+    }
 }

SSMP/Animation/AnimationManager.cs

@@ -2,7 +2,9 @@
 using System.Linq;
 using HutongGames.PlayMaker.Actions;
 using SSMP.Animation.Effects;
+using SSMP.Animation.Effects.Movement;
 using SSMP.Animation.Effects.SilkSkills;
+using SSMP.Animation.Effects.Tools;
 using SSMP.Collection;
 using SSMP.Fsm;
 using SSMP.Game;
@@ -621,9 +623,15 @@ internal class AnimationManager {
         { "Wound Double Strike", AnimationClip.WoundDoubleStrike },
         { "Wound Zap", AnimationClip.WoundZap },
 
+        { "Bench", AnimationClip.Bench },
+
         { "Witch Tentacles!", AnimationClip.WitchTentacles },
         { "Shaman Cancel", AnimationClip.ShamanCancel },
-        { "Bind Fail Burst", AnimationClip.BindInterrupt }
+        { "Bind Fail Burst", AnimationClip.BindInterrupt },
+        { "Magnetite Dice", AnimationClip.MagnetiteDice },
+        { "Flea Brew", AnimationClip.FleaBrew },
+        { "Fractured Mask", AnimationClip.FracturedMask },
+        { "Magma Bell", AnimationClip.MagmaBell }
     };
 
     /// <summary>
@@ -662,6 +670,8 @@ internal class AnimationManager {
         { AnimationClip.BindBurstAir, BindBurst.Instance },
         { AnimationClip.RageBindBurst, BindBurst.Instance },
         { AnimationClip.Death, new Death() },
+        { AnimationClip.DoubleJump, new FaydownCloak() },
+        { AnimationClip.UmbrellaInflate, new DriftersCloak() },
 
         // Silk Skills
         { AnimationClip.NeedleThrowThrowing, new SilkSpear() },
@@ -679,9 +689,18 @@ internal class AnimationManager {
         { AnimationClip.WitchTentacles, BindBurst.Instance },
         { AnimationClip.ShamanCancel, new Bind { BindState = Bind.State.ShamanCancel } },
         { AnimationClip.BindInterrupt, BindInterrupt.Instance },
+        { AnimationClip.Bench, new Bench() },
+
+        // Silk Skills
         { AnimationClip.AirSphereRefresh, new ThreadStorm() },
         { AnimationClip.SilkBombLocations, new RuneRage() },
-        { AnimationClip.SilkBossNeedleFire, new PaleNails() }
+        { AnimationClip.SilkBossNeedleFire, new PaleNails() },
+
+        // Tools
+        { AnimationClip.MagnetiteDice, new MagnetiteDice() },
+        { AnimationClip.FleaBrew, FleaBrew.Instance },
+        { AnimationClip.FracturedMask, new FracturedMask() },
+        { AnimationClip.MagmaBell, new MagmaBell() }
     };
 
     /// <summary>
@@ -814,6 +833,7 @@ public void RegisterHooks() {
             CreateHeroHooks(HeroController.instance);
         }
 
+        EventHooks.UseLavaBell += OnMagmaBell;
 
         // Register a callback so we know when the dash has finished
         // On.HeroController.CancelDash += HeroControllerOnCancelDash;
@@ -838,6 +858,17 @@ public void DeregisterHooks() {
 
         HeroController.OnHeroInstanceSet -= CreateHeroHooks;
         FsmStateActionInjector.UninjectAll();
+
+        MagnetiteDice.Unhook();
+
+        EventHooks.HeroControllerDie -= OnDeath;
+        EventHooks.UseLavaBell -= OnMagmaBell;
+
+        // Remove listener for benching
+        var eventRegister = HeroController.SilentInstance?.gameObject.GetComponents<EventRegister>().FirstOrDefault(r => r.SubscribedEvent == "BENCHREST START");
+        if (eventRegister) {
+            eventRegister.ReceivedEvent -= OnBench;
+        }
         // On.HeroAnimationController.Play -= HeroAnimationControllerOnPlay;
         // On.HeroAnimationController.PlayFromFrame -= HeroAnimationControllerOnPlayFromFrame;
 
@@ -1099,6 +1130,9 @@ private void CreateHeroHooks(HeroController hc) {
             bellFsm.Init();
         }
 
+        CreateSkillHooks();
+        CreateToolHooks();
+
         // Find bind FSM
         var heroFsms = hc.GetComponents<PlayMakerFSM>();
 
@@ -1117,8 +1151,53 @@ private void CreateHeroHooks(HeroController hc) {
             Logger.Warn("Unable to find Bind FSM to hook.");
         }
 
+        // Add listener for benching
+        var eventRegister = hc.gameObject.GetComponents<EventRegister>().FirstOrDefault(r => r.SubscribedEvent == "BENCHREST START");
+        if (eventRegister) {
+            eventRegister.ReceivedEvent += OnBench;
+        }
+    }
+
+    /// <summary>
+    /// Animation subanimation hook for the Witch Tentacles FSM state.
+    /// </summary>
+    private void OnWitchTentacles(PlayMakerFSM fsm) {
+        var dummyClip = new tk2dSpriteAnimationClip {
+            name = "Witch Tentacles!",
+            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
+        };
+        OnAnimationEvent(dummyClip);
+    }
+
+    /// <summary>
+    /// Animation subanimation hook for the Shaman Air Cancel FSM state.
+    /// </summary>
+
+    private void OnShamanCancel(PlayMakerFSM fsm) {
+        var dummyClip = new tk2dSpriteAnimationClip {
+            name = "Shaman Cancel",
+            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
+        };
+        OnAnimationEvent(dummyClip);
+    }
+
+    /// <summary>
+    /// Animation subanimation hook for interrupted binds.
+    /// </summary>
+    private void OnBindInterrupt(PlayMakerFSM fsm) {
+        var dummyClip = new tk2dSpriteAnimationClip {
+            name = "Bind Fail Burst",
+            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
+        };
+        OnAnimationEvent(dummyClip);
+    }
+
+    /// <summary>
+    /// Creates hooks for silk skills.
+    /// </summary>
+    private void CreateSkillHooks() {
         // Silk skill injections
-        var silkSkillFsm = hc.silkSpecialFSM;
+        var silkSkillFsm = HeroController.instance.silkSpecialFSM;
         if (silkSkillFsm == null) {
             Logger.Warn("Unable to find Silk Skill FSM to hook.");
             return;
@@ -1191,39 +1270,6 @@ private void CreateHeroHooks(HeroController hc) {
         }
     }
 
-    /// <summary>
-    /// Animation subanimation hook for the Witch Tentacles FSM state.
-    /// </summary>
-    private void OnWitchTentacles(PlayMakerFSM fsm) {
-        var dummyClip = new tk2dSpriteAnimationClip {
-            name = "Witch Tentacles!",
-            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
-        };
-        OnAnimationEvent(dummyClip);
-    }
-
-    /// <summary>
-    /// Animation subanimation hook for the Shaman Air Cancel FSM state.
-    /// </summary>
-    private void OnShamanCancel(PlayMakerFSM fsm) {
-        var dummyClip = new tk2dSpriteAnimationClip {
-            name = "Shaman Cancel",
-            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
-        };
-        OnAnimationEvent(dummyClip);
-    }
-
-    /// <summary>
-    /// Animation subanimation hook for interrupted binds.
-    /// </summary>
-    private void OnBindInterrupt(PlayMakerFSM fsm) {
-        var dummyClip = new tk2dSpriteAnimationClip {
-            name = "Bind Fail Burst",
-            wrapMode = tk2dSpriteAnimationClip.WrapMode.Once
-        };
-        OnAnimationEvent(dummyClip);
-    }
-
     /// <summary>
     /// Animation subanimation hook for extending a thread storm.
     /// </summary>
@@ -1409,6 +1455,101 @@ private void OnPaleNailFire(PlayMakerFSM fsm) {
         _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.SilkBossNeedleFire, 0, effectInfo);
     }
 
+    /// <summary>
+    /// Creates hooks for tools.
+    /// </summary>
+    private void CreateToolHooks() {
+        MagnetiteDice.Hook(OnDiceEnable);
+        MagmaBell.HookRecharge(OnMagmaBellRecharge);
+
+        var toolFsm = HeroController.instance.toolsFSM;
+        var brewBurst = toolFsm.GetState("Flea Brew Burst");
+        FsmStateActionInjector.Inject(brewBurst, OnFleaBrew, 0, "Flea Brew");
+
+        var maskFsm = HeroController.instance.gameObject
+            .FindGameObjectInChildren("Charm Effects")?
+            .FindGameObjectInChildren("Fractured Mask Break")?
+            .LocateMyFSM("Spawn Effect");
+
+        if (maskFsm) {
+            var maskEffect = maskFsm.GetState("Instantiate Effect");
+            FsmStateActionInjector.Inject(maskEffect, OnFracturedMaskBreak, 0, "Fractured Mask Break");
+        }
+    }
+
+    /// <summary>
+    /// Hook for the magnetite dice being triggered.
+    /// </summary>
+    private void OnDiceEnable() {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.MagnetiteDice);
+    }
+
+    /// <summary>
+    /// Hook for the flea brew being triggered.
+    /// </summary>
+    private void OnFleaBrew(PlayMakerFSM fsm) {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        var effectInfo = FleaBrew.Instance.GetEffectInfo();
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.FleaBrew, 0, effectInfo);
+    }
+
+    /// <summary>
+    /// Hook for the fractured mask being triggered.
+    /// </summary>
+    private void OnFracturedMaskBreak(PlayMakerFSM fsm) {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.FracturedMask);
+    }
+
+    /// <summary>
+    /// Hook for the magma bell being triggered.
+    /// </summary>
+    private void OnMagmaBell() {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.MagmaBell, 0, [0]);
+    }
+
+    /// <summary>
+    /// Hook for the magma bell being triggered.
+    /// </summary>
+    private void OnMagmaBellRecharge() {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.MagmaBell, 0, [1]);
+    }
+
+    /// <summary>
+    /// Hook for resting on a bench.
+    /// </summary>
+    private void OnBench() {
+        // If we are not connected, there is nothing to send to
+        if (!_netClient.IsConnected) {
+            return;
+        }
+
+        _netClient.UpdateManager.UpdatePlayerAnimation(AnimationClip.Bench);
+    }
+
     // /// <summary>
     // /// Callback method on the HeroAnimationController#Play method.
     // /// </summary>