Package de.marcely.bedwars.api.cosmetics.animation.custom

Class CustomAnimationHandlerSession

java.lang.Object

de.marcely.bedwars.api.cosmetics.animation.custom.CustomAnimationHandlerSession

All Implemented Interfaces:

AnimationHandler

public abstract class CustomAnimationHandlerSession
extends Object
implements AnimationHandler

Represents a session of when the animation handler shall be played.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CustomAnimationHandlerSession.SessionInfo	Contains all the information neccessary for the handler to do its thing.

Constructor Summary

Constructors

Constructor	Description
CustomAnimationHandlerSession(CustomAnimationHandlerSession.SessionInfo info)	Call this within CustomAnimationHandlerType.openSession(SessionInfo)

Method Summary

Modifier and Type	Method	Description
final CustomAnimationHandlerSession.SessionInfo	getInfo()	Get the neccessary information needed to do your thing.
abstract void	handleStop()	Stop everything you do IMMEDIATELY, and undo everything (blocks etc) you had done.
abstract void	handleTick(int amount)	In case the animation has been configured to be "repeated" / "periodic".
final boolean	isActive()	Get whether the animation hasn't been stopped yet.
final void	stop()	Stop the session immediately.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.marcely.bedwars.api.cosmetics.animation.AnimationHandler

getAnimation, getMaxDurationTicks, getOffsetX, getOffsetY, getOffsetZ, getType, hasOffset

Constructor Details

CustomAnimationHandlerSession

public CustomAnimationHandlerSession(CustomAnimationHandlerSession.SessionInfo info)

Call this within CustomAnimationHandlerType.openSession(SessionInfo)

Parameters:

info - The info you had received from the method prior

Method Details

handleTick

public abstract void handleTick(int amount)

In case the animation has been configured to be "repeated" / "periodic".

May never be called if the animation hasn't been configured to be repeated, or if CustomAnimationHandlerType.isPeriodic() returns false.

There's an amount parameter since the configured frequency may be more than 20x per tick.

Parameters:

amount - Amount of times it shall play for this tick. Always at least 1

handleStop

public abstract void handleStop()

Stop everything you do IMMEDIATELY, and undo everything (blocks etc) you had done.

It's always called if it's supposed to stop, even if you call stop().

getInfo

public final CustomAnimationHandlerSession.SessionInfo getInfo()

Get the neccessary information needed to do your thing.

Returns:

Neccessary info for this session

isActive

public final boolean isActive()

Get whether the animation hasn't been stopped yet.

Returns:

true if it is still handling stuff

stop

public final void stop()

Stop the session immediately.