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

Class SaturationState

java.lang.Object

wbs.utils.util.entities.state.tracker.SaturationState

All Implemented Interfaces:

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

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

An EntityState that captures a Player's current saturation level.

See Also:

• HumanEntity.getSaturation()

Constructor Summary

Constructors

Constructor	Description
SaturationState()	Creates the state with the default value for a player.
SaturationState(float saturation)

Method Summary

Modifier and Type	Method	Description
void	captureState(org.bukkit.entity.Player target)	Capture the state of an instance of EntityState according to the implementation, and store it until EntityState.restoreState(T) is called.
static SaturationState	deserialize(Map<String,Object> args)	Deserializer method for converting a Map into this object, for use in EntityStateManager
@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.Player target)	Restore the state of an instance of EntityState according to the implementation.
@NotNull Map<String,Object>	serialize()

Methods inherited from class java.lang.Object

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

Constructor Details

SaturationState

public SaturationState()

Creates the state with the default value for a player.

SaturationState

public SaturationState(float saturation)

Parameters:

saturation - How much saturation the player has before they will start losing hunger points

Method Details

captureState

public void captureState(org.bukkit.entity.Player 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.Player>

Parameters:

target - The EntityState from which to capture.

restoreState

public void restoreState(org.bukkit.entity.Player 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.Player>

Parameters:

target - The EntityState for which to the stored state.

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.Player>

Returns:

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

deserialize

public static SaturationState 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