public interface PhaseRunner
Interface to handle the running of an animation within an opening animation session.
This interface defines the methods to access animation-related properties and information,
including the animation type, session, crate, player, and animation properties.
It also defines lifecycle and control methods (baseLoad(), baseTick(),
baseUnload(), nextPhase()) that manage the execution flow of the animation.
-
Method Summary
void
Performs the base load sequence of the animation.
void
Performs the base tick logic of the animation.
void
Performs the base unload sequence of the animation.
Gets the opening animation handler responsible for this animation.
Gets the animation phase associated with this runner, describing the current stage of animation.
Gets the properties for this animation, allowing access to configurable settings
that control its behavior.
void
Proceeds to the next phase of the animation.
-
Method Details
-
getHandler
Gets the opening animation handler responsible for this animation.
- Returns:
- The opening animation handler.
-
getPhase
Gets the animation phase associated with this runner, describing the current stage of animation.
- Returns:
- The animation phase.
-
getProperties
Gets the properties for this animation, allowing access to configurable settings
that control its behavior.
- Returns:
- The animation properties.
-
baseLoad
void baseLoad()
Performs the base load sequence of the animation.
Typically calls load() and sets internal state
to mark the animation as ready to tick.
-
baseTick
void baseTick()
Performs the base tick logic of the animation.
Handles waiting states and calls tick() when appropriate.
-
baseUnload
void baseUnload()
Performs the base unload sequence of the animation.
Typically calls unload() to release resources and stop the animation.
-
nextPhase
void nextPhase()
Proceeds to the next phase of the animation.
If another animation is currently playing, this may set the runner
into a waiting state until it can advance.