Merge pull request #218 from JimmyHelp/1.20

Add `animation:isHolding()`
FiguraMC · May 21, 2024 · e26f692 · e26f692
2 parents aa70f09 + 607e4f3
commit e26f692
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 9 deletions.
diff --git a/common/src/main/java/org/figuramc/figura/animation/Animation.java b/common/src/main/java/org/figuramc/figura/animation/Animation.java
@@ -101,7 +101,11 @@ public void tick() {
                 else if (inverted && time < offset - loopDelay)
                     time += length + loopDelay - offset;
             }
-            case HOLD -> time = inverted ? Math.max(time, offset) : Math.min(time, length);
+            case HOLD -> {
+                time = inverted ? Math.max(time, offset) : Math.min(time, length);
+                if (time == length)
+                playState = PlayState.HOLDING;
+            }
         }
 
         this.lastTime = this.frameTime;
@@ -158,6 +162,12 @@ public boolean isStopped() {
         return this.playState == PlayState.STOPPED;
     }
 
+    @LuaWhitelist
+    @LuaMethodDoc("animation.is_holding")
+    public boolean isHolding() {
+        return this.playState == PlayState.HOLDING;
+    }
+
     @LuaWhitelist
     @LuaMethodDoc("animation.play")
     public Animation play() {
@@ -598,7 +608,8 @@ public String toString() {
     public enum PlayState {
         STOPPED,
         PAUSED,
-        PLAYING
+        PLAYING,
+        HOLDING
     }
 
     public enum LoopMode {

diff --git a/common/src/main/java/org/figuramc/figura/lua/api/AnimationAPI.java b/common/src/main/java/org/figuramc/figura/lua/api/AnimationAPI.java
@@ -4,6 +4,7 @@
 import org.figuramc.figura.avatar.Avatar;
 import org.figuramc.figura.lua.LuaWhitelist;
 import org.figuramc.figura.lua.docs.LuaMethodDoc;
+import org.figuramc.figura.lua.docs.LuaMethodOverload;
 import org.figuramc.figura.lua.docs.LuaTypeDoc;
 
 import java.util.ArrayList;
@@ -51,11 +52,20 @@ public List<Animation> getAnimations() {
     }
 
     @LuaWhitelist
-    @LuaMethodDoc("animations.get_playing")
-    public List<Animation> getPlaying() {
+    @LuaMethodDoc(
+            overloads = {
+                    @LuaMethodOverload,
+                    @LuaMethodOverload(
+                            argumentTypes = Boolean.class,
+                            argumentNames = "hold"
+                    )
+            },
+            value = "animations.get_playing"
+    )
+    public List<Animation> getPlaying(boolean hold) {
         List<Animation> list = new ArrayList<>();
         for (Animation animation : avatar.animations.values())
-            if (animation.playState == Animation.PlayState.PLAYING)
+            if (hold ? (animation.playState == Animation.PlayState.PLAYING || animation.playState == Animation.PlayState.HOLDING) : (animation.playState == Animation.PlayState.PLAYING))
                 list.add(animation);
         return list;
     }

diff --git a/common/src/main/resources/assets/figura/lang/en_us.json b/common/src/main/resources/assets/figura/lang/en_us.json
@@ -741,13 +741,14 @@
     "figura.docs.wheel_action.set_toggled": "Sets the toggle state of the Action",
     "figura.docs.animations": "A global API used for control of Blockbench Animations",
     "figura.docs.animations.get_animations": "Returns a table with all animations",
-    "figura.docs.animations.get_playing": "Return a table with all playing animations",
+    "figura.docs.animations.get_playing": "Return a table with all playing animations\nIf true is passed in for hold animations in the HOLDING play state will be included",
     "figura.docs.animations.stop_all": "Stops all playing (and paused) animations",
     "figura.docs.animation": "A Blockbench animation",
     "figura.docs.animation.name": "This animation's name",
-    "figura.docs.animation.animation.is_playing": "Checks if this animation is being played",
-    "figura.docs.animation.animation.is_paused": "Checks if this animation is paused",
-    "figura.docs.animation.animation.is_stopped": "Checks if this animation is stopped",
+    "figura.docs.animation.is_playing": "Checks if this animation is being played",
+    "figura.docs.animation.is_paused": "Checks if this animation is paused",
+    "figura.docs.animation.is_stopped": "Checks if this animation is stopped",
+    "figura.docs.animation.is_holding": "Checks if this animation is holding on its last frame",
     "figura.docs.animation.play": "Initializes the animation\nResume the animation if it was paused",
     "figura.docs.animation.pause": "Pause the animation's playback",
     "figura.docs.animation.stop": "Stop the animation",