io.github.nucleuspowered.nucleus.api.module.warp.data

Interface Warp

All Superinterfaces:

NamedLocation

public interface Warp
extends NamedLocation

Represents a warp.

Method Summary

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

Methods inherited from interface io.github.nucleuspowered.nucleus.api.util.data.NamedLocation

getLocation, getName, getPosition, getRotation, getTransform, getWorldProperties, getWorldUUID

Method Detail

getCategory

java.util.Optional<java.lang.String> getCategory()

Gets the category for this warp, if it exists.

Returns:

The category name.

getCost

java.util.Optional<java.lang.Double> getCost()

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

Returns:

The cost.

getDescription

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

Gets the description for the warp.

Returns:

The Text description, if available.