io.github.nucleuspowered.nucleus.api.util.data

Interface NamedLocation

All Known Subinterfaces:

Home, Warp

public interface NamedLocation

Represents a location that has a name attached to it.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getLocation() Gets the Location if the world is loaded.
java.lang.String	getName() Gets the name of the location.
com.flowpowered.math.vector.Vector3d	getPosition() Gets the position.
com.flowpowered.math.vector.Vector3d	getRotation() Gets the rotation.
java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>>	getTransform() Gets the Transform if the world is loaded.
java.util.Optional<org.spongepowered.api.world.storage.WorldProperties>	getWorldProperties() Gets the WorldProperties that this location points to, if the world exists.
java.util.UUID	getWorldUUID() Gets the world UUID that this location targets

Method Detail

getWorldUUID

java.util.UUID getWorldUUID()

Gets the world UUID that this location targets

Returns:

The world UUID

getWorldProperties

java.util.Optional<org.spongepowered.api.world.storage.WorldProperties> getWorldProperties()

Gets the WorldProperties that this location points to, if the world exists.

Returns:

The World Properties

getRotation

com.flowpowered.math.vector.Vector3d getRotation()

Gets the rotation.

Returns:

The rotation

getPosition

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

Gets the position.

Returns:

The position

getLocation

java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getLocation()

Gets the Location if the world is loaded.

Returns:

The Location if the world is loaded.

getTransform

java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>> getTransform()

Gets the Transform if the world is loaded.

Returns:

The Transform if the world is loaded.

getName

java.lang.String getName()

Gets the name of the location.

Returns:

The name