Package com.pixelmonmod.pixelmon.api.battles.animation.client

Interface ClientBattleAnimationPlayback

public interface ClientBattleAnimationPlayback
Client-side handle for a visible animation effect started by the server.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final ClientBattleAnimationPlayback
    NONE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static ClientBattleAnimationPlayback
    cleanup(Runnable cleanup)
    Creates playback that only runs cleanup when stopped.
    default boolean
    isFinished()
    Returns whether this client playback is complete.
    void
    stop()
    Stops this playback and releases any client-side state it owns.
    void
    tick()
    Advances this client playback by one client tick.

  • Field Details

  • Method Details

    • cleanup

      static ClientBattleAnimationPlayback cleanup(Runnable cleanup)
      Creates playback that only runs cleanup when stopped.
      Parameters:
      cleanup - the cleanup action to run
      Returns:
      a cleanup-only playback handle

    • tick

      void tick()
      Advances this client playback by one client tick.

    • stop

      void stop()
      Stops this playback and releases any client-side state it owns.

    • isFinished

      default boolean isFinished()
      Returns whether this client playback is complete.
      Returns:
      true when playback is finished