io.github.nucleuspowered.nucleus.api.nucleusdata

Interface WarpCategory

public interface WarpCategory

Defines a warp category.

Method Summary

Modifier and Type	Method and Description
Optional<org.spongepowered.api.text.Text>	getDescription() Gets the defined description of the category, if available.
org.spongepowered.api.text.Text	getDisplayName() Gets the display name of the category.
String	getId() Gets the ID of the category.
Collection<Warp>	getWarps() Gets the warps associated with this category.

Method Detail

getId

String getId()

Gets the ID of the category.

Returns:

The ID.

getDisplayName

org.spongepowered.api.text.Text getDisplayName()

Gets the display name of the category. Defaults to the category name.

Returns:

The display name.

getDescription

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

Gets the defined description of the category, if available.

Returns:

An Optional that might contain a description.

getWarps

Collection<Warp> getWarps()

Gets the warps associated with this category.

Returns:

The warps.