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

Interface RTPKernel

All Superinterfaces:

org.spongepowered.api.CatalogType

@CatalogedBy(value=RTPKernels.class)
public interface RTPKernel
extends org.spongepowered.api.CatalogType

An RTPKernel provides the instructions for how to select a location when using RTP.

RTPKernels can be registered in the appropriate registry.

Kernels can base logic on a supplied location, but are expected to handle cases where a null or invalid location is supplied.

Method Summary

Modifier and Type	Method and Description
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 target, NucleusRTPService.RTPOptions options) Gets a new location.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

getLocation

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 target,
                                                                                                        NucleusRTPService.RTPOptions options)

Gets a new location.

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

Parameters:

currentLocation - The current location of the entity to teleport, if appropriate

target - The target world for teleport

options - The options to consider when teleporting

Returns:

The location to teleport to, if any.