Method Detail

• getType

  PhaseType getType()

  Gets the current phase of the animation.

  Returns:

  The current phase type of the animation.

• getId

  String getId()

  Gets the unique identifier for this animation.

  Returns:

  The ID of the animation, used to uniquely identify it.

• getDisplayName

  String getDisplayName()

  Gets the display name for the animation. This name can be used in UI elements or for identification purposes.

  Returns:

  The display name of the animation.

• getDisplayItem

  org.bukkit.inventory.ItemStack getDisplayItem()

  Gets the display item associated with this animation. This item may be used to visually represent the animation in the interface.

  Returns:

  The item stack representing the display item.

• isVersionCompatible

  boolean isVersionCompatible()

  Checks whether this animation is compatible with the current server version.

  Returns:

  true if compatible, false otherwise.

• getRequiredVersion

  String getRequiredVersion()

  Gets the required server version for this animation to work.

  Returns:

  the version string required.

• getEnvironment

  default AnimationEnvironment getEnvironment()

  Returns where this animation phase is presented.

  Returns:

  animation environment

• createRunner

  PhaseRunner createRunner(OpeningAnimationHandler handler,
                           AnimationProperties properties)

  Creates a new runner instance for this animation phase. The runner controls the execution of the animation during crate opening.

  Parameters:

  handler - the animation handler managing the opening process

  properties - the properties used to configure this animation

  Returns:

  a new PhaseRunner responsible for running the animation

• getLegacyDataClass

  @Deprecated
  default Class<?> getLegacyDataClass()

  Deprecated. This method is deprecated and will be removed in a future release.
  Legacy support method.

  This method exists only for backwards compatibility with older implementations. It should not be used in new code and may be removed in future versions.

  Returns:

  the legacy data class, or null if not applicable

• isLite

  @ApiStatus.Internal
   @Deprecated
  default boolean isLite()

  Deprecated. Method currently being used internally only, shouldn't be overwritten.
  Indicates whether this feature is lite-only. If you are creating your animation, you can ignore this.

  Returns:

  true if it requires lite access.

• isPremium

  @ApiStatus.Internal
   @Deprecated
  default boolean isPremium()

  Deprecated. Method currently being used internally only, shouldn't be overwritten.
  Indicates whether this feature is premium-only. If you are creating your animation, you can ignore this.

  Returns:

  true if it requires premium access.

• isPro

  @ApiStatus.Internal
   @Deprecated
  default boolean isPro()

  Deprecated. Method currently being used internally only, shouldn't be overwritten.
  Indicates whether this feature is pro-only. If you are creating your animation, you can ignore this.

  Returns:

  true if it requires pro access.