org.spongepowered.api.data

Interface LocatableSnapshot<T extends LocatableSnapshot<T>>

Type Parameters:

T - The type of location snapshot for self referencing

All Superinterfaces:

DataSerializable, ImmutableDataHolder<T>, ImmutableValueStore<T,ImmutableDataManipulator<?,?>>, PropertyHolder, ValueContainer<T>

All Known Subinterfaces:

BlockSnapshot, EntitySnapshot

public interface LocatableSnapshot<T extends LocatableSnapshot<T>>
extends ImmutableDataHolder<T>

A type of ImmutableDataHolder that may be linked to a particular Location. Being that a LocatableSnapshot may be built by an ImmutableDataBuilder, the Location may be null such that getLocation() returns Optional.empty().

Method Summary

Modifier and Type	Method and Description
Optional<Location<World>>	getLocation() Gets the Location of the snapshot at which it may have been taken from.
com.flowpowered.math.vector.Vector3i	getPosition() Gets the saved block position.
UUID	getWorldUniqueId() Gets the UUID of the world.
T	withLocation(Location<World> location) Creates a copy of the snapshot with the provided Location.

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

getManipulators

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

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.immutable.ImmutableValueStore

get, getContainers, getOrCreate, merge, merge, supports, transform, with, with, with, with, without

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

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

Method Detail

getWorldUniqueId

UUID getWorldUniqueId()

Gets the UUID of the world.

Returns:

The world unique Id

getPosition

com.flowpowered.math.vector.Vector3i getPosition()

Gets the saved block position.

Returns:

The saved block position

getLocation

Optional<Location<World>> getLocation()

Gets the Location of the snapshot at which it may have been taken from. The Location being immutable signifies that the LocatableSnapshot can be re-created at the desired Location.

Returns:

The location of where the snapshot was taken, if available

withLocation

T withLocation(Location<World> location)

Creates a copy of the snapshot with the provided Location.

Parameters:

location - The location

Returns:

The new snapshot