Package sawfowl.commandpack.api

Interface RandomTeleportService

public interface RandomTeleportService

A tool for getting random positions in the world.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RandomTeleportService.RandomTeleportOptions	These teleportation options to a random position must be used to find a position.

Method Summary

Modifier and Type	Method	Description
static RandomTeleportService.RandomTeleportOptions.Builder	createOptions()	Create new random teleport options.
RandomTeleportService.RandomTeleportOptions	getDefault()	Default teleportation options. The method always returns a copy from the plugin configuration.
Optional<ServerLocation>	getLocation(ServerLocation currentLocation, RandomTeleportService.RandomTeleportOptions options)	Search for a teleportation position in the target world.
CompletableFuture<Optional<ServerLocation>>	getLocationFuture(ServerLocation currentLocation, RandomTeleportService.RandomTeleportOptions options)	Search for a teleportation position in the target world. Async mode.
RandomTeleportService.RandomTeleportOptions	getOptions(ResourceKey worldKey)	Getting options from the plugin configuration for the specified world. If no world is found, the default options will be selected. The method always returns a copy from the plugin configuration.
RandomTeleportService.RandomTeleportOptions	getOptions(ServerWorld world)	Getting options from the plugin configuration for the specified world. If no world is found, the default options will be selected. The method always returns a copy from the plugin configuration.

Method Details

getLocation

Optional<ServerLocation> getLocation(ServerLocation currentLocation,
 RandomTeleportService.RandomTeleportOptions options)

Search for a teleportation position in the target world.

Parameters:

currentLocation - - The current location of the entity.

options - - Options for finding a random position.

Returns:

ServerLocation

getLocationFuture

CompletableFuture<Optional<ServerLocation>> getLocationFuture(ServerLocation currentLocation,
 RandomTeleportService.RandomTeleportOptions options)

Search for a teleportation position in the target world.
Async mode. Teleportation is only possible in the main thread.
Despite the asynchrony, a large number of attempts to find a location can crash the server.

Parameters:

currentLocation - - The current location of the entity.

options - - Options for finding a random position.

Returns:

ServerLocation

getOptions

RandomTeleportService.RandomTeleportOptions getOptions(ServerWorld world)

Getting options from the plugin configuration for the specified world.
If no world is found, the default options will be selected.
The method always returns a copy from the plugin configuration. Changing the copy will not affect the original values.

Returns:

RandomTeleportService.RandomTeleportOptions

getOptions

RandomTeleportService.RandomTeleportOptions getOptions(ResourceKey worldKey)

Getting options from the plugin configuration for the specified world.
If no world is found, the default options will be selected.
The method always returns a copy from the plugin configuration. Changing the copy will not affect the original values.

Returns:

RandomTeleportService.RandomTeleportOptions

getDefault

RandomTeleportService.RandomTeleportOptions getDefault()

Default teleportation options.
The method always returns a copy from the plugin configuration. Changing the copy will not affect the original values.

Returns:

RandomTeleportService.RandomTeleportOptions

createOptions

static RandomTeleportService.RandomTeleportOptions.Builder createOptions()

Create new random teleport options.