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

respawnWorld - the key of the world the player respawns in, or null for the world spawn

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

world - the key of the world the player was last in, or null if never saved (i.e. a first join)

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

Enclosing interface:

PlayerDataStorage

public static record PlayerDataStorage.PlayerData(GameMode gameMode, @Nullable Key respawnWorld, @Nullable Location respawnLocation, @Nullable Key world, @Nullable Location location)
extends Record

Constructor Summary

Constructors

Constructor	Description
PlayerData(GameMode gameMode, @Nullable Key respawnWorld, @Nullable Location respawnLocation, @Nullable Key world, @Nullable Location location)	Creates an instance of a PlayerData record class.

Method Summary

Modifier and Type	Method	Description
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.
boolean	hasLastLocation()
boolean	hasRespawnPoint()
@Nullable Location	location()	Returns the value of the location record component.
@Nullable Location	respawnLocation()	Returns the value of the respawnLocation record component.
@Nullable Key	respawnWorld()	Returns the value of the respawnWorld record component.
final String	toString()	Returns a string representation of this record class.
@Nullable Key	world()	Returns the value of the world record component.

Methods inherited from class Object

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

Constructor Details

PlayerData

public PlayerData(GameMode gameMode,
 @Nullable Key respawnWorld,
 @Nullable Location respawnLocation,
 @Nullable Key world,
 @Nullable Location location)

Creates an instance of a PlayerData record class.

Parameters:

gameMode - the value for the gameMode record component

respawnWorld - the value for the respawnWorld record component

respawnLocation - the value for the respawnLocation record component

world - the value for the world record component

location - the value for the location record component

Method Details

hasRespawnPoint

public boolean hasRespawnPoint()

Returns:

true when a custom respawn point was saved

hasLastLocation

public boolean hasLastLocation()

Returns:

true when a last-played position was saved

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

respawnWorld

public @Nullable Key respawnWorld()

Returns the value of the respawnWorld record component.

Returns:

the value of the respawnWorld record component

respawnLocation

public @Nullable Location respawnLocation()

Returns the value of the respawnLocation record component.

Returns:

the value of the respawnLocation record component

world

public @Nullable Key world()

Returns the value of the world record component.

Returns:

the value of the world record component

location

public @Nullable Location location()

Returns the value of the location record component.

Returns:

the value of the location record component