io.github.nucleuspowered.nucleus.api.service

Interface NucleusWarpService

public interface NucleusWarpService

Gets a service that allows users to warp about using defined warp.

Method Summary

Modifier and Type	Method and Description
List<Warp>	getAllWarps() Gets all the warps available.
List<Warp>	getUncategorisedWarps() Get all warps that have not been given a category.
Optional<Warp>	getWarp(String warpName) Gets the location for the specified warp.
Optional<WarpCategory>	getWarpCategory(String category) Gets the data associated with a warp category.
Set<String>	getWarpNames() Gets the names of all the warp that are available.
List<Warp>	getWarpsForCategory(String category) Gets all warps that hae been given the specified category.
default Map<WarpCategory,List<Warp>>	getWarpsWithCategories() Gets all warps that have categories.
Map<WarpCategory,List<Warp>>	getWarpsWithCategories(Predicate<Warp> warpDataPredicate) Gets all warps that have categories.
boolean	removeWarp(String warpName) Removes a warp.
boolean	removeWarpCost(String warpName) Removes the cost of a warp.
boolean	setWarp(String warpName, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation) Sets a warp, will not overwrite current warp.
boolean	setWarpCategory(String warpName, String category) Sets a warp's category
boolean	setWarpCategoryDescription(String category, org.spongepowered.api.text.Text description) Sets the description of a warp category.
boolean	setWarpCategoryDisplayName(String category, org.spongepowered.api.text.Text displayName) Sets the display name of a warp category.
boolean	setWarpCost(String warpName, double cost) Sets the cost of a warp.
boolean	setWarpDescription(String warpName, org.spongepowered.api.text.Text description) Sets a warp's description.
default boolean	warpExists(String name) Gets whether a warp exists.

Method Detail

getWarp

Optional<Warp> getWarp(String warpName)

Gets the location for the specified warp.

Parameters:

warpName - The name of the warp to check.

Returns:

The Location of the warp, or Optional.empty() otherwise.

removeWarp

boolean removeWarp(String warpName)

Removes a warp.

Parameters:

warpName - The name of the warp.

Returns:

true if the warp was there and removed, false if the warp never existed.

setWarp

boolean setWarp(String warpName,
                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                com.flowpowered.math.vector.Vector3d rotation)

Sets a warp, will not overwrite current warp.

Parameters:

warpName - The name of the warp to set.

location - The location of the warp.

rotation - The rotation of the warp.

Returns:

true if set, false otherwise.

getAllWarps

List<Warp> getAllWarps()

Gets all the warps available.

If you just want to display the names, use getWarpNames() instead.

Returns:

All warps in Nucleus.

getUncategorisedWarps

List<Warp> getUncategorisedWarps()

Get all warps that have not been given a category.

Returns:

The Warps without a category.

getWarpsForCategory

List<Warp> getWarpsForCategory(String category)

Gets all warps that hae been given the specified category.

Parameters:

category - The category.

Returns:

The warps.

getWarpsWithCategories

default Map<WarpCategory,List<Warp>> getWarpsWithCategories()

Gets all warps that have categories.

Returns:

The warps.

getWarpsWithCategories

Map<WarpCategory,List<Warp>> getWarpsWithCategories(Predicate<Warp> warpDataPredicate)

Gets all warps that have categories.

Parameters:

warpDataPredicate - The filtering predicate to return the subset of warps required.

Returns:

The warps.

removeWarpCost

boolean removeWarpCost(String warpName)

Removes the cost of a warp.

Parameters:

warpName - The name of the warp to remove the cost from.

Returns:

true if the cost removal succeeds.

setWarpCost

boolean setWarpCost(String warpName,
                    double cost)

Sets the cost of a warp.

Parameters:

warpName - The name of the warp to change the cost of.

cost - The cost to use the warp. Set to zero (or negative) to disable.

Returns:

true if the cost is set, false otherwise.

setWarpCategory

boolean setWarpCategory(String warpName,
                        @Nullable
                        String category)

Sets a warp's category

Parameters:

warpName - The name of the warp.

category - The name of the category.

Returns:

true if successful

setWarpDescription

boolean setWarpDescription(String warpName,
                           @Nullable
                           org.spongepowered.api.text.Text description)

Sets a warp's description.

Parameters:

warpName - The name of the warp.

description - The description, or null to clear.

Returns:

true if successful

getWarpNames

Set<String> getWarpNames()

Gets the names of all the warp that are available.

Returns:

A set of warp.

warpExists

default boolean warpExists(String name)

Gets whether a warp exists.

Parameters:

name - The name to check for.

Returns:

true if it exists, false otherwise.

getWarpCategory

Optional<WarpCategory> getWarpCategory(String category)

Gets the data associated with a warp category.

Parameters:

category - The name of the category to get.

Returns:

An Optional containing the category, if it exists.

setWarpCategoryDisplayName

boolean setWarpCategoryDisplayName(String category,
                                   @Nullable
                                   org.spongepowered.api.text.Text displayName)

Sets the display name of a warp category.

Parameters:

category - The name of the category.

displayName - The display name. Set to null to revert to the category name.

Returns:

true if the category exists and this is successful.

setWarpCategoryDescription

boolean setWarpCategoryDescription(String category,
                                   @Nullable
                                   org.spongepowered.api.text.Text description)

Sets the description of a warp category.

Parameters:

category - The name of the category.

description - The description. Set to null to remove the description.

Returns:

true if the category exists and this is successful.