org.spongepowered.api.util

Class RespawnLocation

java.lang.Object

org.spongepowered.api.util.RespawnLocation

All Implemented Interfaces:

DataSerializable

public final class RespawnLocation
extends Object
implements DataSerializable

Represents a position for a player to respawn in in a particular world. Instances can be obtained using RespawnLocationData or by using the builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RespawnLocation.Builder A helper class to build RespawnLocations.

Method Summary

Modifier and Type	Method and Description
Optional<Location<World>>	asLocation() Gets this spawn position as a Location object, if the world is available.
static RespawnLocation.Builder	builder() Creates a new RespawnLocation.Builder to build a RespawnLocation.
boolean	equals(Object o)
int	getContentVersion() Gets the content version of this DataSerializable.
com.flowpowered.math.vector.Vector3d	getPosition() Gets the position within the world of this spawn point.
UUID	getWorldUniqueId() Gets the UUID of the world this position refers to.
int	hashCode()
boolean	isForced() Gets whether the spawn position is forced in the given world, if available.
DataContainer	toContainer() Serializes this object into a comprehensible DataContainer.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static RespawnLocation.Builder builder()

Creates a new RespawnLocation.Builder to build a RespawnLocation.

Returns:

A new builder

getWorldUniqueId

public UUID getWorldUniqueId()

Gets the UUID of the world this position refers to.

Returns:

The world UUID

getPosition

public com.flowpowered.math.vector.Vector3d getPosition()

Gets the position within the world of this spawn point.

Returns:

The spawn position

isForced

public boolean isForced()

Gets whether the spawn position is forced in the given world, if available. A forced position will spawn the player there even if a bed is missing or obstructed.

Returns:

Whether the position is forced in the world

asLocation

public Optional<Location<World>> asLocation()

Gets this spawn position as a Location object, if the world is available.

Returns:

The position object, if available.

getContentVersion

public int getContentVersion()

Description copied from interface: DataSerializable

Gets the content version of this DataSerializable. The version may differ between instances of plugins and implementations such that the DataView from DataSerializable.toContainer() may include different information, or remove other information as they are no longer deemed necessary. The version goes hand in hand with DataContentUpdater as it is required when there exists any DataView of this DataSerializable with an "older" version.

Specified by:

getContentVersion in interface DataSerializable

Returns:

The version of the content being serialized

toContainer

public DataContainer toContainer()

Description copied from interface: DataSerializable

Serializes this object into a comprehensible DataContainer.

Specified by:

toContainer in interface DataSerializable

Returns:

A newly created DataContainer

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object