gyurix.animation

Class AnimationAPI

java.lang.Object

gyurix.animation.AnimationAPI

public final class AnimationAPI
extends java.lang.Object

An API used for running Animations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnimationAPI.CustomEffectHandler The CustomEffectHandler class is used for making custom effects in Animations work as VariableAPI variables for easier usage

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashMap<java.lang.String,java.lang.Class>	effects Custom effect name - Custom effect class mapping
protected static java.util.concurrent.ScheduledExecutorService	pool

Constructor Summary

Constructors

Constructor and Description
AnimationAPI()

Method Summary

Modifier and Type	Method and Description
static void	init() Initializes the AnimationAPI: - registers built in custom effects - registers a CustomEffectHandler for every custom effect - registers the AnimationSerializer
static AnimationRunnable	runAnimation(org.bukkit.plugin.Plugin pl, Animation a, java.lang.String name, org.bukkit.entity.Player plr, AnimationUpdateListener listener) Starts the execution of an Animation
static void	stopRunningAnimation(AnimationRunnable ar) Force stops the given AnimationRunnable
static void	stopRunningAnimations(org.bukkit.entity.Player plr) Force stops every AnimationRunnable linked to the given player.
static void	stopRunningAnimations(org.bukkit.plugin.Plugin pl) Force stops every AnimationRunnable linked to the given plugin.
static void	stopRunningAnimations(org.bukkit.plugin.Plugin pl, org.bukkit.entity.Player plr) Force stops every AnimationRunnable linked to the given plugin and to the given player.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pool

protected static final java.util.concurrent.ScheduledExecutorService pool

effects

public static java.util.HashMap<java.lang.String,java.lang.Class> effects

Custom effect name - Custom effect class mapping

Constructor Detail

AnimationAPI

public AnimationAPI()

Method Detail

init

public static void init()

Initializes the AnimationAPI: - registers built in custom effects - registers a CustomEffectHandler for every custom effect - registers the AnimationSerializer

runAnimation

public static AnimationRunnable runAnimation(org.bukkit.plugin.Plugin pl,
                                             Animation a,
                                             java.lang.String name,
                                             org.bukkit.entity.Player plr,
                                             AnimationUpdateListener listener)

Starts the execution of an Animation

Parameters:

pl - - Plugin which wants to start the Animation, used for auto stopping it, when the plugin is unloaded

a - - The runnable Animation

name - - The name under which the Animation should be executed, this name can help for the plugin to determine what kind of animation is actually running

plr - - The player to who this Animation should be linked. Every placeholder in the Animation will be filled with his data

listener - - The AnimationUpdateListener, which should handle every state change in the animation

Returns:

The AnimationRunnable, usable for cancelling the execution of the Animation at any time

stopRunningAnimation

public static void stopRunningAnimation(AnimationRunnable ar)

Force stops the given AnimationRunnable

Parameters:

ar - - The stoppable AnimationRunnable

stopRunningAnimations

public static void stopRunningAnimations(org.bukkit.entity.Player plr)

Force stops every AnimationRunnable linked to the given player. This method is automatically executed by SpigotLib, when player logs out.

Parameters:

plr - - Target player

stopRunningAnimations

public static void stopRunningAnimations(org.bukkit.plugin.Plugin pl)

Force stops every AnimationRunnable linked to the given plugin. This method is automatically executed by SpigotLib, when a plugin is unloaded.

Parameters:

pl - - Target plugin

stopRunningAnimations

public static void stopRunningAnimations(org.bukkit.plugin.Plugin pl,
                                         org.bukkit.entity.Player plr)

Force stops every AnimationRunnable linked to the given plugin and to the given player. This method helps plugins to stop their AnimationRunnables without keeping their instances.

Parameters:

pl - - Target plugin

plr - - Target Player