feat: add current_frame_index getter from animation state (#49)

jcornaz · Mar 6, 2022 · 1e30613 · 1e30613
1 parent a5e7ea8
commit 1e30613
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/state.rs b/src/state.rs
@@ -50,6 +50,14 @@ impl SpriteSheetAnimationState {
         *self = Self::default();
     }
 
+    /// Returns the index of the current frame
+    ///
+    /// The index is relative to the animation sequence. **not** to the sprite-sheet.
+    #[must_use]
+    pub fn current_frame_index(&self) -> usize {
+        self.current_frame
+    }
+
     /// Update the animation and the sprite (if necessary)
     ///
     /// Returns true if the animation has ended