Package io.github.projectunified.craftux.button

Class AnimatedButton

java.lang.Object
io.github.projectunified.craftux.button.MultiButton
io.github.projectunified.craftux.button.AnimatedButton
All Implemented Interfaces:
Button, Element
public class AnimatedButton extends MultiButton
A button that cycles through a list of buttons as animation frames over time. Each frame is displayed for a configurable period, creating an animated effect.

Example usage:


 AnimatedButton animatedButton = new AnimatedButton();
 animatedButton.addButton(
     new SimpleButton(new ItemStack(Material.DIAMOND)),
     new SimpleButton(new ItemStack(Material.EMERALD))
 );
 animatedButton.setPeriodMillis(100); // 100ms per frame

  • Constructor Details

    • AnimatedButton

      public AnimatedButton()

  • Method Details

    • setPeriodMillis

      public void setPeriodMillis(long periodMillis)
      Sets the period of the animation between frame changes.
      Parameters:
      periodMillis - the period in milliseconds
      Throws:
      IllegalArgumentException - if periodMillis is not positive

    • setMode

      public void setMode(AnimationMode mode)
      Set the mode of the animation
      Parameters:
      mode - the mode of the animation

    • stop

      public void stop()
      Description copied from interface: Element
      Stop the element. Should be called after removing from the GUI.
      Specified by:
      stop in interface Element
      Overrides:
      stop in class MultiButton

    • apply

      public boolean apply(@NotNull @NotNull UUID uuid, @NotNull @NotNull ActionItem actionItem)
      Description copied from interface: Button
      Apply actions to the action item
      Parameters:
      uuid - the uuid of the player
      actionItem - the action item
      Returns:
      true if any action was applied. Can return false in a conditional case (e.g. predicate button)