io.github.nucleuspowered.nucleus.api.teleport

Interface NucleusSafeTeleportService

public interface NucleusSafeTeleportService

Contains routines that support Nucleus safe teleports

Method Summary

Modifier and Type	Method and Description
java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>>	getSafeLocation(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, TeleportScanner scanner, org.spongepowered.api.world.teleport.TeleportHelperFilter filter, org.spongepowered.api.world.teleport.TeleportHelperFilter... filters) Find a safe location around the given location, subject to the given TeleportScanner or TeleportHelperFilter.
java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>>	getSafeTransform(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation, TeleportScanner scanner, org.spongepowered.api.world.teleport.TeleportHelperFilter filter, org.spongepowered.api.world.teleport.TeleportHelperFilter... filters) Find a safe location around the given location, subject to the given TeleportScanner or TeleportHelperFilter.
TeleportResult	teleportPlayer(org.spongepowered.api.entity.living.player.Player player, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, boolean centreBlock, TeleportScanner scanner, org.spongepowered.api.world.teleport.TeleportHelperFilter filter, org.spongepowered.api.world.teleport.TeleportHelperFilter... filters) Teleports a player to a specified location, using a TeleportScanner that determines how to select a location.
TeleportResult	teleportPlayer(org.spongepowered.api.entity.living.player.Player player, org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location, com.flowpowered.math.vector.Vector3d rotation, boolean centreBlock, TeleportScanner scanner, org.spongepowered.api.world.teleport.TeleportHelperFilter filter, org.spongepowered.api.world.teleport.TeleportHelperFilter... filters) Teleports a player to a specified location, using a TeleportScanner that determines how to select a location.

Method Detail

teleportPlayer

TeleportResult teleportPlayer(org.spongepowered.api.entity.living.player.Player player,
                              org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                              boolean centreBlock,
                              TeleportScanner scanner,
                              org.spongepowered.api.world.teleport.TeleportHelperFilter filter,
                              org.spongepowered.api.world.teleport.TeleportHelperFilter... filters)

Teleports a player to a specified location, using a TeleportScanner that determines how to select a location.

Parameters:

player - The player to teleport

location - The approximate location to teleport to

centreBlock - If true, teleport a player to the centre of a block else, teleports to a conrner.

scanner - The TeleportScanner to use to determine how to select the next location when a safe location has not been found.

filter - The first TeleportHelperFilter to use to determine whether a block is safe.

filters - Additional TeleportHelperFilters to use when when determining whether a block is safe.

Returns:

The result of the teleport.

teleportPlayer

TeleportResult teleportPlayer(org.spongepowered.api.entity.living.player.Player player,
                              org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                              com.flowpowered.math.vector.Vector3d rotation,
                              boolean centreBlock,
                              TeleportScanner scanner,
                              org.spongepowered.api.world.teleport.TeleportHelperFilter filter,
                              org.spongepowered.api.world.teleport.TeleportHelperFilter... filters)

Teleports a player to a specified location, using a TeleportScanner that determines how to select a location.

Parameters:

player - The player to teleport

location - The approximate location to teleport to

rotation - The rotation of the player upon teleport

centreBlock - If true, teleport a player to the centre of a block else, teleports to a conrner.

scanner - The TeleportScanner to use to determine how to select the next location when a safe location has not been found.

filter - The first TeleportHelperFilter to use to determine whether a block is safe.

filters - Additional TeleportHelperFilters to use when when determining whether a block is safe.

Returns:

The result of the teleport.

getSafeLocation

java.util.Optional<org.spongepowered.api.world.Location<org.spongepowered.api.world.World>> getSafeLocation(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                                                                                                            TeleportScanner scanner,
                                                                                                            org.spongepowered.api.world.teleport.TeleportHelperFilter filter,
                                                                                                            org.spongepowered.api.world.teleport.TeleportHelperFilter... filters)

Find a safe location around the given location, subject to the given TeleportScanner or TeleportHelperFilter.

Parameters:

location - The location to find a safe location around

scanner - The TeleportScanner to use to determine how to select the next location when a safe location has not been found.

filter - The first TeleportHelperFilter to use to determine whether a block is safe.

filters - Additional TeleportHelperFilters to use when when determining whether a block is safe.

Returns:

The Location, if one is avaiable.

getSafeTransform

java.util.Optional<org.spongepowered.api.entity.Transform<org.spongepowered.api.world.World>> getSafeTransform(org.spongepowered.api.world.Location<org.spongepowered.api.world.World> location,
                                                                                                               com.flowpowered.math.vector.Vector3d rotation,
                                                                                                               TeleportScanner scanner,
                                                                                                               org.spongepowered.api.world.teleport.TeleportHelperFilter filter,
                                                                                                               org.spongepowered.api.world.teleport.TeleportHelperFilter... filters)

Find a safe location around the given location, subject to the given TeleportScanner or TeleportHelperFilter.

Parameters:

location - The location to find a safe location around

rotation - The rotation for the Transform

scanner - The TeleportScanner to use to determine how to select the next location when a safe location has not been found.

filter - The first TeleportHelperFilter to use to determine whether a block is safe.

filters - Additional TeleportHelperFilters to use when when determining whether a block is safe.

Returns:

The Location, if one is avaiable.