org.spongepowered.api.data.manipulator.immutable.entity

Interface ImmutableRespawnLocation

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableRespawnLocation,RespawnLocationData>, ImmutableMappedData<UUID,RespawnLocation,ImmutableRespawnLocation,RespawnLocationData>, ValueContainer<ImmutableRespawnLocation>

public interface ImmutableRespawnLocation
extends ImmutableMappedData<UUID,RespawnLocation,ImmutableRespawnLocation,RespawnLocationData>

An ImmutableDataManipulator for the "respawn" location of a Player. A Player may have multiple respawn locations, but can only have a single respawn location per World. A location can be "forced", which means they will spawn there even if it's not a valid bed.

Method Summary

Modifier and Type	Method and Description
default Optional<RespawnLocation>	getForWorld(World world) Gets the respawn location for the given world, if available.
default ImmutableMapValue<UUID,RespawnLocation>	respawnLocation() Gets the ImmutableMapValue for the "respawn" locations set for various World.getUniqueId() such that a Player may not have a respawn point for a particular World, but may have multiple respawn points for other Worlds.

Methods inherited from interface org.spongepowered.api.data.manipulator.immutable.ImmutableMappedData

asMap, get, getMapKeys, getMapValue, getMapValues

Methods inherited from interface org.spongepowered.api.data.manipulator.ImmutableDataManipulator

asMutable, copy, with, with

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

respawnLocation

default ImmutableMapValue<UUID,RespawnLocation> respawnLocation()

Gets the ImmutableMapValue for the "respawn" locations set for various World.getUniqueId() such that a Player may not have a respawn point for a particular World, but may have multiple respawn points for other Worlds.

Returns:

The immutable map for the respawn locations per world id

getForWorld

default Optional<RespawnLocation> getForWorld(World world)

Gets the respawn location for the given world, if available. If the respawn point for that world has not been set, Optional.empty() is returned.

Parameters:

world - The world to check

Returns:

The RespawnLocation