io.github.nucleuspowered.nucleus.api.module.rtp

Interface NucleusRTPService

public interface NucleusRTPService

Allows for the customisation of RTP selection routines.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NucleusRTPService.RTPOptions The RTP options to pass to the routines

Method Summary

Modifier and Type	Method and Description
RTPKernel	getDefaultKernel() Gets the RTPKernel that Nucleus' RTP will use.
RTPKernel	getKernel(java.lang.String world) Gets the default RTPKernel used when executing a random teleport
RTPKernel	getKernel(org.spongepowered.api.world.storage.WorldProperties world) Gets the default RTPKernel used when executing a random teleport
default java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getLocation(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> currentLocation, org.spongepowered.api.world.World world, NucleusRTPService.RTPOptions options) Uses the default RTP kernel (from getDefaultKernel() to find a random location, given the provided NucleusRTPService.RTPOptions.
default NucleusRTPService.RTPOptions	options() Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for a default world.
NucleusRTPService.RTPOptions	options(org.spongepowered.api.world.storage.WorldProperties world) Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for the specified world.
NucleusRTPService.RTPOptions.Builder	optionsBuilder() Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration, but in builder format.
void	registerKernel(RTPKernel kernel) Registers a kernel for use in Nucleus.

Method Detail

options

default NucleusRTPService.RTPOptions options()

Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for a default world.

Returns:

The NucleusRTPService.RTPOptions

options

NucleusRTPService.RTPOptions options(@Nullable
                                     org.spongepowered.api.world.storage.WorldProperties world)

Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration for the specified world.

Parameters:

world - The WorldProperties, or null for defaults.

Returns:

The NucleusRTPService.RTPOptions

optionsBuilder

NucleusRTPService.RTPOptions.Builder optionsBuilder()

Gets the NucleusRTPService.RTPOptions that contains the current rtp configuration, but in builder format.

Changes in the builder do not affect the configuration, this is for overriding in specific circumstances.

Returns:

The NucleusRTPService.RTPOptions

getDefaultKernel

RTPKernel getDefaultKernel()

Gets the RTPKernel that Nucleus' RTP will use.

This is set by the rtp config, using the kernel's ID.

Returns:

The RTPKernel

getLocation

default java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getLocation(@Nullable
                                                                                                                org.spongepowered.api.world.Location<org.spongepowered.api.world.World> currentLocation,
                                                                                                                org.spongepowered.api.world.World world,
                                                                                                                NucleusRTPService.RTPOptions options)

Uses the default RTP kernel (from getDefaultKernel() to find a random location, given the provided NucleusRTPService.RTPOptions.

Note that this may fail if the search times out. This does not indicate a failing routine.

A source of confusion is that this method works in exactly the same way as the rtp command. It does not. The RTP command makes attempts over multiple ticks to keep the server running while increasing the chance of finding a suitable spot.

This method makes one attempt at finding a suitable location. You may need to run this more than once.

Parameters:

currentLocation - The current location to base the RTP off.

world - The world to warp to

options - The RTP options to use

Returns:

The location if one was found.

getKernel

RTPKernel getKernel(org.spongepowered.api.world.storage.WorldProperties world)

Gets the default RTPKernel used when executing a random teleport

Parameters:

world - The world to get the kernel for

Returns:

The kernel

getKernel

RTPKernel getKernel(java.lang.String world)

Gets the default RTPKernel used when executing a random teleport

Parameters:

world - The name of the world to get the kernel for

Returns:

The kernel

registerKernel

void registerKernel(RTPKernel kernel)

Registers a kernel for use in Nucleus.

Parameters:

kernel - The kernel.