@CatalogedBy(value=RTPKernels.class) public interface RTPKernel extends CatalogType
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.
Modifier and Type | Method and Description |
---|---|
Optional<Location<World>> |
getLocation(Location<World> currentLocation,
World target,
NucleusRTPService.RTPOptions options)
Gets a new location.
|
getId, getName
Optional<Location<World>> getLocation(@Nullable Location<World> currentLocation, World target, NucleusRTPService.RTPOptions options)
Note that this may fail if the search times out. This does not indicate a failing routine.
currentLocation
- The current location of the entity to teleport, if appropriatetarget
- The target world for teleportoptions
- The options to consider when teleporting