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

Class CustomAnimationHandlerSession.SessionInfo

java.lang.Object

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

Enclosing class:

CustomAnimationHandlerSession

public static final class CustomAnimationHandlerSession.SessionInfo
extends Object

Contains all the information neccessary for the handler to do its thing.

Constructor Summary

Constructors

Constructor	Description
SessionInfo()

Method Summary

Modifier and Type	Method	Description
@Nullable Arena	getArena()	Get the arena in which the arena is played in.
ConfigurationSection	getConfigs()	Get the configs set in the animation's file for this handler.
Location	getLocation()	Get the position at which the animation shall play at.
<T> T	getNative()	Deprecated. Ignore this!
Player	getPlayer()	The main subject related to the animation.
Player	getRelatedPlayer()	The related subject for the animation.

Methods inherited from class java.lang.Object

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

Constructor Details

SessionInfo

public SessionInfo()

Method Details

getArena

@Nullable
public @Nullable Arena getArena()

Get the arena in which the arena is played in.

The animation may not leave the boundaries of the arena!

Returns:

The animation in which the animation had started. May be null if it has been started using a command

getLocation

public Location getLocation()

Get the position at which the animation shall play at.

Automatically considers offsets and other user configurations. Just use this one. It may change over time, just call it again with upcoming ticks.

Returns:

The current location at which the animation shall be held

getPlayer

public Player getPlayer()

The main subject related to the animation.

Returns:

The main player

getRelatedPlayer

public Player getRelatedPlayer()

The related subject for the animation.

May be equal to getPlayer().

Returns:

The related player of the animation

getConfigs

public ConfigurationSection getConfigs()

Get the configs set in the animation's file for this handler.

Returns:

The configs you can use

getNative

@Deprecated
public <T> T getNative()

Deprecated.

Ignore this!

Ignore this! For internal usage.

Type Parameters:

T - Ignore this!

Returns:

Ignore this!