From 14526d24d3f767d73ee49e43fea06be130130396 Mon Sep 17 00:00:00 2001
From: Ellpeck <me@ellpeck.de>
Date: Tue, 21 Dec 2021 20:17:02 +0100
Subject: [PATCH] cleaned up the sprite animation changes

---
 MLEM/Animations/SpriteAnimation.cs      |  7 ++++---
 MLEM/Animations/SpriteAnimationGroup.cs | 10 +++++++---
 2 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/MLEM/Animations/SpriteAnimation.cs b/MLEM/Animations/SpriteAnimation.cs
index f72e09b..121b4c5 100644
--- a/MLEM/Animations/SpriteAnimation.cs
+++ b/MLEM/Animations/SpriteAnimation.cs
@@ -103,8 +103,8 @@ namespace MLEM.Animations {
         /// </summary>
         /// <param name="timePerFrame">The amount of time that each frame should last for</param>
         /// <param name="regions">The texture regions that should make up this animation</param>
-        public SpriteAnimation(double timePerFrame, params TextureRegion[] regions)
-            : this(Array.ConvertAll(regions, r => new AnimationFrame(timePerFrame, r))) {
+        public SpriteAnimation(double timePerFrame, params TextureRegion[] regions) :
+            this(Array.ConvertAll(regions, r => new AnimationFrame(timePerFrame, r))) {
         }
 
         /// <summary>
@@ -187,7 +187,8 @@ namespace MLEM.Animations {
         /// The texture region that this frame should render.
         /// If there are multiple regions, <see cref="Regions"/> should be used instead.
         /// </summary>
-        public TextureRegion Region => this.Regions[0];
+        /// <exception cref="InvalidOperationException">Thrown if this animation frame has more than one region, in which case <see cref="Regions"/> should be used instead.</exception>
+        public TextureRegion Region => this.Regions.Count == 1 ? this.Regions[0] : throw new InvalidOperationException("Cannot return single region for an animation frame with multiple regions");
 
         /// <summary>
         /// Creates a new animation frame based on a set of texture regions and a time.
diff --git a/MLEM/Animations/SpriteAnimationGroup.cs b/MLEM/Animations/SpriteAnimationGroup.cs
index e7f8146..ac62c1a 100644
--- a/MLEM/Animations/SpriteAnimationGroup.cs
+++ b/MLEM/Animations/SpriteAnimationGroup.cs
@@ -25,18 +25,22 @@ namespace MLEM.Animations {
             set => this.currAnimation = value;
         }
         /// <summary>
-        /// The animation that is currently playing
+        /// Returns the animation that is currently playing.
         /// </summary>
         public SpriteAnimation CurrentAnimation => this.CurrAnimation?.Animation;
         /// <summary>
-        /// The frame that <see cref="CurrentAnimation"/> is displaying
+        /// Returns the frame that <see cref="CurrentAnimation"/> is displaying.
         /// </summary>
         public AnimationFrame CurrentFrame => this.CurrentAnimation?.CurrentFrame;
         /// <summary>
-        /// The region that <see cref="CurrentFrame"/> has
+        /// Returns the <see cref="CurrentAnimation"/>'s <see cref="SpriteAnimation.CurrentRegion"/>.
         /// </summary>
         public TextureRegion CurrentRegion => this.CurrentAnimation?.CurrentRegion;
         /// <summary>
+        /// Returns the <see cref="CurrentAnimation"/>'s <see cref="SpriteAnimation.CurrentRegions"/>.
+        /// </summary>
+        public IList<TextureRegion> CurrentRegions => this.CurrentAnimation?.CurrentRegions;
+        /// <summary>
         /// A callback for when the currently displaying animation has changed due to a condition with a higher priority being met. 
         /// </summary>
         public event AnimationChanged OnAnimationChanged;