add AnimationMode

Author: HSGamer

animation/src/main/java/io/github/projectunified/craftux/animation/Animation.java

@@ -20,16 +20,18 @@
 public class Animation<T> {
     private final List<T> frames;
     private final long periodMillis;
+    private final AnimationMode mode;
     private final AtomicLong startMillis = new AtomicLong(-1);
 
     /**
      * Creates a new Animation with the specified frames and period.
      *
      * @param frames       the list of frames to cycle through
      * @param periodMillis the period in milliseconds between frame changes
+     * @param mode         the mode of the animation
      * @throws IllegalArgumentException if frames is empty or periodMillis is not positive
      */
-    public Animation(List<T> frames, long periodMillis) {
+    public Animation(List<T> frames, long periodMillis, AnimationMode mode) {
         if (frames.isEmpty()) {
             throw new IllegalArgumentException("Frames cannot be empty");
         }
@@ -39,6 +41,18 @@ public Animation(List<T> frames, long periodMillis) {
 
         this.frames = frames;
         this.periodMillis = periodMillis;
+        this.mode = mode;
+    }
+
+    /**
+     * Creates a new Animation with the specified frames and period.
+     *
+     * @param frames       the list of frames to cycle through
+     * @param periodMillis the period in milliseconds between frame changes
+     * @throws IllegalArgumentException if frames is empty or periodMillis is not positive
+     */
+    public Animation(List<T> frames, long periodMillis) {
+        this(frames, periodMillis, AnimationMode.REPEAT);
     }
 
     /**
@@ -62,6 +76,15 @@ public T getCurrentFrame(long currentMillis) {
             startMillis = currentMillis;
             this.startMillis.set(startMillis);
         }
+
+        if (!isFirstRun(currentMillis)) {
+            if (mode == AnimationMode.ONE_TIME) {
+                return null;
+            } else if (mode == AnimationMode.ONE_TIME_KEEP_LAST) {
+                return frames.getLast();
+            }
+        }
+
         long diff = currentMillis - startMillis;
         int index = (int) (diff / periodMillis) % frames.size();
         return frames.get(index);

animation/src/main/java/io/github/projectunified/craftux/animation/AnimationMode.java

@@ -0,0 +1,19 @@
+package io.github.projectunified.craftux.animation;
+
+/**
+ * The mode of {@link Animation}
+ */
+public enum AnimationMode {
+    /**
+     * The frame will be repeated
+     */
+    REPEAT,
+    /**
+     * The {@link Animation#getCurrentFrame(long)}} will return {@link null} if the animation is completed ({@link Animation#isFirstRun(long)} returns {@link false})
+     */
+    ONE_TIME,
+    /**
+     * The {@link Animation#getCurrentFrame(long)}} will return the last element of the {@link Animation#getFrames()} if the animation is completed ({@link Animation#isFirstRun(long)} returns {@link false})
+     */
+    ONE_TIME_KEEP_LAST
+}

button/src/main/java/io/github/projectunified/craftux/button/AnimatedButton.java

@@ -1,6 +1,7 @@
 package io.github.projectunified.craftux.button;
 
 import io.github.projectunified.craftux.animation.Animation;
+import io.github.projectunified.craftux.animation.AnimationMode;
 import io.github.projectunified.craftux.common.ActionItem;
 import io.github.projectunified.craftux.common.Button;
 import org.jetbrains.annotations.NotNull;
@@ -26,6 +27,7 @@
 public class AnimatedButton extends MultiButton {
     private final Map<UUID, Animation<Button>> animationMap = new ConcurrentHashMap<>();
     private long periodMillis = 50L;
+    private AnimationMode mode = AnimationMode.REPEAT;
 
     /**
      * Sets the period of the animation between frame changes.
@@ -40,8 +42,17 @@ public void setPeriodMillis(long periodMillis) {
         this.periodMillis = periodMillis;
     }
 
+    /**
+     * Set the mode of the animation
+     *
+     * @param mode the mode of the animation
+     */
+    public void setMode(AnimationMode mode) {
+        this.mode = mode;
+    }
+
     private Animation<Button> getAnimation(UUID uuid) {
-        return animationMap.computeIfAbsent(uuid, key -> new Animation<>(buttons, periodMillis));
+        return animationMap.computeIfAbsent(uuid, key -> new Animation<>(buttons, periodMillis, mode));
     }
 
     @Override

mask/src/main/java/io/github/projectunified/craftux/mask/AnimatedMask.java

@@ -1,6 +1,7 @@
 package io.github.projectunified.craftux.mask;
 
 import io.github.projectunified.craftux.animation.Animation;
+import io.github.projectunified.craftux.animation.AnimationMode;
 import io.github.projectunified.craftux.common.ActionItem;
 import io.github.projectunified.craftux.common.Mask;
 import io.github.projectunified.craftux.common.Position;
@@ -31,6 +32,7 @@
 public class AnimatedMask extends MultiMask<Mask> {
     private final Map<UUID, Animation<Mask>> animationMap = new ConcurrentHashMap<>();
     private long periodMillis = 50;
+    private AnimationMode mode = AnimationMode.REPEAT;
 
     /**
      * Set the period of the animation
@@ -44,8 +46,17 @@ public void setPeriodMillis(long periodMillis) {
         this.periodMillis = periodMillis;
     }
 
+    /**
+     * Set the mode of the animation
+     *
+     * @param mode the mode of the animation
+     */
+    public void setMode(AnimationMode mode) {
+        this.mode = mode;
+    }
+
     private Animation<Mask> getAnimation(@NotNull UUID uuid) {
-        return animationMap.computeIfAbsent(uuid, k -> new Animation<>(elements, periodMillis));
+        return animationMap.computeIfAbsent(uuid, k -> new Animation<>(elements, periodMillis, mode));
     }
 
     @Override