Package wbs.utils.util.entities.state.tracker

Class FallDistanceState

java.lang.Object

wbs.utils.util.entities.state.tracker.FallDistanceState

All Implemented Interfaces:

org.bukkit.configuration.serialization.ConfigurationSerializable, EntityState<org.bukkit.entity.Entity>

public class FallDistanceState
extends Object
implements EntityState<org.bukkit.entity.Entity>, org.bukkit.configuration.serialization.ConfigurationSerializable

An EntityState that captures an Entity's current distance fallen, used for damage calculations (among other uses).

See Also:

• Entity.getFallDistance()

Constructor Summary

Constructors

Constructor	Description
FallDistanceState()	Creates the state with the default value (0).
FallDistanceState(float fallDistance)

Method Summary

Modifier and Type	Method	Description
void	captureState(org.bukkit.entity.Entity target)	Capture the state of an instance of EntityState according to the implementation, and store it until EntityState.restoreState(T) is called.
static FallDistanceState	deserialize(Map<String,Object> args)	Deserializer method for converting a Map into this object, for use in EntityStateManager
float	getFallDistance()
@NotNull Set<Class<? extends EntityState<?>>>	restoreAfter()	Used to build a graph of captured states, allowing states to be restored in the appropriate order, such as restoring AllowFlightState after GameModeState, to prevent a change to GameMode.SURVIVAL from overriding the Player.getAllowFlight() state.
void	restoreState(org.bukkit.entity.Entity target)	Restore the state of an instance of EntityState according to the implementation.
@NotNull Map<String,Object>	serialize()
void	setFallDistance(float fallDistance)

Methods inherited from class java.lang.Object

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

Constructor Details

FallDistanceState

public FallDistanceState()

Creates the state with the default value (0).

FallDistanceState

public FallDistanceState(float fallDistance)

Parameters:

fallDistance - How far the entity has fallen.

Method Details

captureState

public void captureState(org.bukkit.entity.Entity target)

Description copied from interface: EntityState

Capture the state of an instance of EntityState according to the implementation, and store it until EntityState.restoreState(T) is called.

Specified by:

captureState in interface EntityState<org.bukkit.entity.Entity>

Parameters:

target - The EntityState from which to capture.

restoreState

public void restoreState(org.bukkit.entity.Entity target)

Description copied from interface: EntityState

Restore the state of an instance of EntityState according to the implementation.

Specified by:

restoreState in interface EntityState<org.bukkit.entity.Entity>

Parameters:

target - The EntityState for which to the stored state.

getFallDistance

public float getFallDistance()

Returns:

How far the entity has fallen.

setFallDistance

public void setFallDistance(float fallDistance)

Parameters:

fallDistance - How far the entity has fallen.

restoreAfter

@NotNull
public @NotNull Set<Class<? extends EntityState<?>>> restoreAfter()

Description copied from interface: EntityState

Used to build a graph of captured states, allowing states to be restored in the appropriate order, such as restoring AllowFlightState after GameModeState, to prevent a change to GameMode.SURVIVAL from overriding the Player.getAllowFlight() state.

Specified by:

restoreAfter in interface EntityState<org.bukkit.entity.Entity>

Returns:

A set of classes to restore after, if present in a given SavedEntityState.

deserialize

public static FallDistanceState deserialize(Map<String,Object> args)

Deserializer method for converting a Map into this object, for use in EntityStateManager

Parameters:

args - The partially deserialized Map.

Returns:

An instance of this class, deserialized from args.

serialize

@NotNull
public @NotNull Map<String,Object> serialize()

Specified by:

serialize in interface org.bukkit.configuration.serialization.ConfigurationSerializable