io.github.nucleuspowered.nucleus.api.nucleusdata

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
Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getLocation() Gets the Location if the world is loaded.
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.
Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>>	getTransform() Gets the Transform if the world is loaded.
Optional<org.spongepowered.api.world.storage.WorldProperties>	getWorldProperties() Gets the WorldProperties that this location points to, if the world exists.

Method Detail

getWorldProperties

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

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

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

String getName()

Gets the name of the location.

Returns:

The name