Enum Class Animation.AnimationState

java.lang.Object
java.lang.Enum<Animation.AnimationState>
nl.pim16aap2.animatedarchitecture.core.animation.Animation.AnimationState
All Implemented Interfaces:
Serializable, Comparable<Animation.AnimationState>, Constable
Enclosing class:
Animation<T extends IAnimatedBlock>

public static enum Animation.AnimationState extends Enum<Animation.AnimationState>
Represents the various stages an animation can be in.
  • Enum Constant Details

    • PENDING

      public static final Animation.AnimationState PENDING
      The animation hasn't started yet.
    • ACTIVE

      public static final Animation.AnimationState ACTIVE
      The animation is currently ongoing.
    • FINISHING

      public static final Animation.AnimationState FINISHING
      The animation is in the process of finishing up. This means that the animated blocks are being moved to their final positions.
    • STOPPING

      public static final Animation.AnimationState STOPPING
      The animation has finished and the animated blocks are about to be placed down as normal blocks.
    • COMPLETED

      public static final Animation.AnimationState COMPLETED
      The animation has completed; there are no animated blocks left.
    • SKIPPED

      public static final Animation.AnimationState SKIPPED
      The animation was skipped. This can happen either because it was requested to skip the animation or because there are no blocks to animate.

      Note that this only applies to the animation itself; the structure itself is still toggled and all blocks (if applicable) are moved to the next location.

  • Method Details

    • values

      public static Animation.AnimationState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Animation.AnimationState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null