Record Class PlayerDataStorage.PlayerData

java.lang.Object

java.lang.Record

fr.fidorial.storage.player.PlayerDataStorage.PlayerData

Record Components:

gameMode - the mode the player left in

abilities - the player's movement abilities

respawnLocation - the position the player respawns at, or null for the world spawn

lastLocation - the position the player was last at, or null if never saved

Enclosing interface:

PlayerDataStorage

public static record PlayerDataStorage.PlayerData(GameMode gameMode, PlayerAbilities abilities, @Nullable Location respawnLocation, @Nullable Location lastLocation)
extends Record

The persisted state of a player.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
PlayerData(GameMode gameMode, PlayerAbilities abilities, @Nullable Location respawnLocation, @Nullable Location lastLocation)	Creates an instance of a PlayerData record class.

Method Summary

Modifier and Type	Method	Description
PlayerAbilities	abilities()	Returns the value of the abilities record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GameMode	gameMode()	Returns the value of the gameMode record component.
final int	hashCode()	Returns a hash code value for this object.
@Nullable Location	lastLocation()	Returns the value of the lastLocation record component.
@Nullable Location	respawnLocation()	Returns the value of the respawnLocation record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PlayerData

public PlayerData(GameMode gameMode,
 PlayerAbilities abilities,
 @Nullable Location respawnLocation,
 @Nullable Location lastLocation)

Creates an instance of a PlayerData record class.

Parameters:

gameMode - the value for the gameMode record component

abilities - the value for the abilities record component

respawnLocation - the value for the respawnLocation record component

lastLocation - the value for the lastLocation record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

gameMode

public GameMode gameMode()

Returns the value of the gameMode record component.

Returns:

the value of the gameMode record component

abilities

public PlayerAbilities abilities()

Returns the value of the abilities record component.

Returns:

the value of the abilities record component

respawnLocation

public @Nullable Location respawnLocation()

Returns the value of the respawnLocation record component.

Returns:

the value of the respawnLocation record component

lastLocation

public @Nullable Location lastLocation()

Returns the value of the lastLocation record component.

Returns:

the value of the lastLocation record component