fix(2120): send animation source information and use it to cancel spell cast animations

Author: pandinocoder

Framework/Intersect.Framework.Core/GameObjects/Animations/AnimationSource.cs

@@ -0,0 +1,5 @@
+using Intersect.GameObjects.Animations;
+
+namespace Intersect.Framework.Core.GameObjects.Animations;
+
+public record struct AnimationSource(AnimationSourceType Type, Guid Id);

Framework/Intersect.Framework.Core/GameObjects/Animations/AnimationSourceType.cs

@@ -0,0 +1,7 @@
+namespace Intersect.GameObjects.Animations;
+
+public enum AnimationSourceType
+{
+    Any,
+    SpellCast,
+}

Intersect (Core)/Network/Packets/Server/PlayAnimationPacket.cs

@@ -1,5 +1,6 @@
 using MessagePack;
 using Intersect.Enums;
+using Intersect.GameObjects.Animations;
 
 namespace Intersect.Network.Packets.Server;
 
@@ -18,7 +19,9 @@ public PlayAnimationPacket(
         Guid mapId,
         int x,
         int y,
-        Direction direction
+        Direction direction,
+        AnimationSourceType sourceType = AnimationSourceType.Any,
+        Guid sourceId = default
     )
     {
         AnimationId = animId;
@@ -28,6 +31,8 @@ Direction direction
         X = x;
         Y = y;
         Direction = direction;
+        SourceType = sourceType;
+        SourceId = sourceId;
     }
 
     [Key(0)]
@@ -51,4 +56,10 @@ Direction direction
     [Key(6)]
     public Direction Direction { get; set; }
 
+    [Key(7)]
+    public AnimationSourceType SourceType { get; set; }
+
+    [Key(8)]
+    public Guid SourceId { get; set; }
+
 }

Intersect.Client.Core/Entities/Animation.cs

@@ -5,7 +5,9 @@
 using Intersect.Client.Framework.Graphics;
 using Intersect.Client.General;
 using Intersect.Enums;
+using Intersect.Framework.Core.GameObjects.Animations;
 using Intersect.GameObjects;
+using Intersect.GameObjects.Animations;
 using Intersect.Utilities;
 
 namespace Intersect.Client.Entities;
@@ -26,7 +28,7 @@ public partial class Animation : IAnimation
 
     private readonly int mLowerLoop;
 
-    private readonly Entity? mParent;
+    private readonly IEntity? mParent;
 
     private Direction mRenderDir;
 
@@ -52,6 +54,8 @@ public partial class Animation : IAnimation
 
     public AnimationBase? MyBase { get; set; }
 
+    public AnimationSource Source { get; }
+
     public Point Size => CalculateAnimationSize();
 
     private int mZDimension = -1;
@@ -61,10 +65,12 @@ public Animation(
         bool loopForever,
         bool autoRotate = false,
         int zDimension = -1,
-        Entity? parent = null
+        IEntity? parent = null,
+        AnimationSource source = default
     )
     {
         MyBase = animBase;
+        Source = source;
         mParent = parent;
         if (MyBase != null)
         {

Intersect.Client.Core/Entities/Entity.cs

@@ -14,7 +14,9 @@
 using Intersect.Client.Spells;
 using Intersect.Core;
 using Intersect.Enums;
+using Intersect.Framework.Core.GameObjects.Animations;
 using Intersect.GameObjects;
+using Intersect.GameObjects.Animations;
 using Intersect.GameObjects.Maps;
 using Intersect.Network.Packets.Server;
 using Intersect.Utilities;
@@ -27,7 +29,9 @@ public partial class Entity : IEntity
     public int AnimationFrame { get; set; }
 
     //Entity Animations
-    public List<Animation> Animations { get; set; } = [];
+    public readonly List<Animation> Animations = [];
+
+    public readonly Dictionary<AnimationSource, Animation> AnimationsBySource = [];
 
     //Animation Timer (for animated sprites)
     public long AnimationTimer { get; set; }

Intersect.Client.Core/Maps/MapAnimation.cs

@@ -1,7 +1,9 @@
 using Intersect.Client.Entities;
+using Intersect.Client.Framework.Entities;
 using Intersect.Client.Framework.Maps;
 using Intersect.GameObjects;
 using Intersect.Enums;
+using Intersect.Framework.Core.GameObjects.Animations;
 
 namespace Intersect.Client.Maps;
 
@@ -16,12 +18,24 @@ public partial class MapAnimation : Animation, IMapAnimation
 
     private int mTileY;
 
-
-    public MapAnimation(AnimationBase animBase, int tileX, int tileY, Direction dir, Entity owner = null) : base(animBase, false, false, -1, owner)
+    public MapAnimation(
+        AnimationBase animBase,
+        int tileX,
+        int tileY,
+        Direction dir,
+        IEntity? owner = null,
+        AnimationSource source = default
+    ) : base(
+        animBase,
+        false,
+        false,
+        -1,
+        owner,
+        source: source
+    )
     {
         mTileX = tileX;
         mTileY = tileY;
         mDir = dir;
     }
-
 }

Intersect.Client.Core/Maps/MapInstance.cs

@@ -15,6 +15,7 @@
 using Intersect.Compression;
 using Intersect.Core;
 using Intersect.Enums;
+using Intersect.Framework.Core.GameObjects.Animations;
 using Intersect.Framework.Core.Serialization;
 using Intersect.GameObjects;
 using Intersect.GameObjects.Maps;
@@ -720,19 +721,37 @@ private void ClearAttributeSounds()
     }
 
     //Animations
-    public void AddTileAnimation(Guid animId, int tileX, int tileY, Direction dir = Direction.None, IEntity owner = null)
+    public void AddTileAnimation(
+        Guid animId,
+        int tileX,
+        int tileY,
+        Direction dir = Direction.None,
+        IEntity? owner = null,
+        AnimationSource source = default
+    )
     {
         var animBase = AnimationBase.Get(animId);
         if (animBase == null)
         {
             return;
         }
 
-        var anim = new MapAnimation(animBase, tileX, tileY, dir, owner as Entity);
+        var anim = new MapAnimation(
+            animBase,
+            tileX,
+            tileY,
+            dir,
+            owner as Entity,
+            source: source
+        );
         LocalAnimations.TryAdd(anim.Id, anim);
         anim.SetPosition(
             X + tileX * _tileWidth + _tileHalfWidth,
-            Y + tileY * _tileHeight + _tileHalfHeight, tileX, tileY, Id, dir
+            Y + tileY * _tileHeight + _tileHalfHeight,
+            tileX,
+            tileY,
+            Id,
+            dir
         );
     }