io.github.nucleuspowered.nucleus.api.nucleusdata

Interface Warp

All Superinterfaces:

NamedLocation

public interface Warp
extends NamedLocation

Represents a warp.

Method Summary

Modifier and Type	Method and Description
Optional<String>	getCategory() Gets the category for this warp, if it exists.
Optional<Double>	getCost() Gets the cost of this warp, if the warp has a cost.
Optional<org.spongepowered.api.text.Text>	getDescription() Gets the description for the warp.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.nucleusdata.NamedLocation

getLocation, getName, getPosition, getRotation, getTransform, getWorldProperties

Method Detail

getCategory

Optional<String> getCategory()

Gets the category for this warp, if it exists.

Returns:

The category name.

getCost

Optional<Double> getCost()

Gets the cost of this warp, if the warp has a cost.

Returns:

The cost.

getDescription

Optional<org.spongepowered.api.text.Text> getDescription()

Gets the description for the warp.

Returns:

The Text description, if available.