Record Class RespawnPoint

java.lang.Object

java.lang.Record

fr.fidorial.entity.RespawnPoint

Record Components:

world - the world to respawn in

location - the position and orientation to respawn at

public record RespawnPoint(World world, Location location)
extends Record

The place a player comes back to after dying.

A point is bound to a World: when that world is no longer loaded at respawn time the server silently falls back to the configured world spawn and clears the point.

Since:

0.1.0

See Also:

• Player.setRespawnPoint(RespawnPoint)

Constructor Summary

Constructors

Constructor	Description
RespawnPoint(World world, Location location)	Creates an instance of a RespawnPoint record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Location	location()	Returns the value of the location record component.
static RespawnPoint	of(Entity entity)
static RespawnPoint	of(World world, double x, double y, double z)
static RespawnPoint	of(World world, Location location)
final String	toString()	Returns a string representation of this record class.
World	world()	Returns the value of the world record component.

Methods inherited from class Object

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

Constructor Details

RespawnPoint

public RespawnPoint(World world,
 Location location)

Creates an instance of a RespawnPoint record class.

Parameters:

world - the value for the world record component

location - the value for the location record component

Method Details

of

public static RespawnPoint of(World world,
 Location location)

Parameters:

world - the world to respawn in

location - the position to respawn at

Returns:

a point at that position

of

public static RespawnPoint of(World world,
 double x,
 double y,
 double z)

Parameters:

world - the world to respawn in

x - the x coordinate

y - the y coordinate

z - the z coordinate

Returns:

a point at those coordinates, facing south

of

public static RespawnPoint of(Entity entity)

Parameters:

entity - the entity whose current placement is captured

Returns:

a point at that entity's world and location

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.

world

public World world()

Returns the value of the world record component.

Returns:

the value of the world record component

location

public Location location()

Returns the value of the location record component.

Returns:

the value of the location record component