Playing Animations

Getting DisplayAnimations

//DisplayAnimations are the serializable version of a SpawnedDisplayAnimation

//Get a DisplayAnimation from a storage location (LOCAL, MONGODB, or MYSQL)
DisplayAnimation savedAnimation = DisplayAnimationManager.getAnimation(LoadMethod.LOCAL, "animationTag");

//Get a DisplayAnimation from an InputStream
DisplayAnimation savedAnimation = DisplayAnimationManager.getAnimation(InputStream);

//Get a DisplayAnimation from a File
DisplayAnimation savedAnimation = DisplayAnimationManager.getAnimation(File);

//Get a DisplayAnimation stored in a plugin's resources
DisplayAnimation savedAnimation = DisplayAnimationManager.getAnimation(MyPlugin.getInstance(), "animationTag");

Getting a SpawnedDisplayAnimation (Playable)

DisplayAnimation savedAnimation = yourMethodToGetADisplayAnimation();

//Convert DisplayAnimation into a SpawnedDisplayAnimation
SpawnedDisplayAnimation spawnedAnimation = savedAnimation.toSpawnedDisplayAnimation();

//Get a SpawnedDisplayAnimation from cache or storage (cache prioritized)
SpawnedDisplayAnimation cacheOrStorageAnimation = DisplayAnimationManager.getSpawnedDisplayAnimation("animationTag", LoadMethod.LOCAL);

//Get a SpawnedDisplayAnimation ONLY if cached
SpawnedDisplayAnimation cachedOnlyAnimation = DisplayAnimationManager.getCachedAnimation("animationTag");

Playing and Stopping Animations

ActiveGroup<?> group = yourMethodToGetAnActiveGroup(); //A Spawned or Packet Group

//This is a quick way to play an animation on a group
DisplayAnimator animator = group.animate(spawnedAnimation);

//Play a looping animation on a group
DisplayAnimator animator = group.animateLooping(spawnedAnimation);

//Show an animation frame on an ActiveGroup
int frameId = 5; //5 is the frame ID (index), but it is the 6th frame of the animation
group.setToFrame(spawnedAnimation, frameId);

//Stopping Animations
group.stopAnimation(displayAnimator); //Stop a DisplayAnimator controlled animation

boolean removeFromStateMachine = false;//Optionally unregister the group from an animation state machine
group.stopAnimations(removeFromStateMachine); //Stops ALL Animations

Animate with a DisplayAnimator

//DisplayAnimators provide more control over an animation and 
//the type of animation to be performed (LINEAR or LOOP)

//Create a linear animator (Animates an ActiveGroup once)
DisplayAnimator linearAnimator = new DisplayAnimator(savedAnimation, DisplayAnimator.AnimationType.LINEAR);

int frameId = 0; //0 is the frame ID (index), but it is the 1st frame of the animation
//Play an animation on a group
linearAnimator.play(group, frameId);

//Play an animation on a group using packets
//PacketDisplayEntityGroups do this even if DisplayAnimator#play is used
linearAnimator.playUsingPackets(group, frameId);

//Play a packet-based animation for a specific player 
linearAnimator.play(player, group, frameId);

//Play a packet-based animation for a group of players. (This is more efficient than repeatedly using the method above for each player)
linearAnimation.play(players, group, frameId);

//Stop an animation on a group
linearAnimator.stop(group);

//Stop an animation for a specific player on a specific group
linearAnimator.stop(player, group);

//Stop all animations using this animator for a specific player
linearAnimator.stop(player);

//Create a looping animator (Plays repeatedly after DisplayAnimator#start() and runs until DisplayAnimator#stop() is called)
DisplayAnimator loopingAnimator = new DisplayAnimator(savedAnimation, DisplayAnimator.AnimationType.LOOP)

Playing Animation Cameras

DisplayAnimator animator = yourMethodToGetADisplayAnimator();

//Set a player's perspective to the animation's camera and play the 
//camera's movements to the player
Player player;
ActiveGroup<?> group;
int startFrameId;
animator.playCamera(player, group, startFrameId);

//Play the animation camera with added delays
int startTransition; //how long in ticks to transition from the player position to camera's 1st frame position
int endDelay; //how long the player should stay in the last frame
animator.playCamera(player, group, startFrameId, startTransition, endDelay);

//Stop the animation camera
DisplayAnimator.stopCameraView(player);

Reverse Animations

SpawnedDisplayAnimation spawnedAnimation = yourMethodToGetASpawnedDisplayAnimation();

//Reverses the order of frames in a SpawnedDisplayAnimation
spawnedAnimation.reverse();

//Get a copy of the animation with reversed frames
SpawnedDisplayAnimation reversedAnimation = spawnedAnimation.getReversedAnimation();

Serialize and save an animation

SpawnedDisplayAnimation spawnedAnimation = yourMethodToGetASpawnedDisplayAnimation();

//Get the serializable version of an animation
DisplayAnimation savedAnimation = spawnedAnimation.toDisplayAnimation();

//Save the animation to a storage location (LOCAL in this case)
DisplayAnimationManager.saveDisplayAnimation(LoadMethod.LOCAL, savedAnimation, null);