Class PlayerTeleportEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerMoveEvent

org.bukkit.event.player.PlayerTeleportEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PlayerPortalEvent, PlayerTeleportEndGatewayEvent

@NullMarked
public class PlayerTeleportEvent
extends PlayerMoveEvent

Holds information for player teleport events

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerTeleportEvent.TeleportCause

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerTeleportEvent(Player player, Location from, Location to)
PlayerTeleportEvent(Player player, Location from, Location to, PlayerTeleportEvent.TeleportCause cause)
PlayerTeleportEvent(Player player, Location from, Location to, PlayerTeleportEvent.TeleportCause cause, Set<TeleportFlag.Relative> teleportFlags)

Method Summary

Modifier and Type	Method	Description
PlayerTeleportEvent.TeleportCause	getCause()	Gets the cause of this teleportation event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
@Unmodifiable Set<TeleportFlag.Relative>	getRelativeTeleportationFlags()	Returns the relative teleportation flags used in this teleportation.
boolean	willDismountPlayer()	Deprecated, for removal: This API element is subject to removal in a future version. dismounting on tp is no longer controlled by the server

Methods inherited from class PlayerMoveEvent

getFrom, getTo, hasChangedBlock, hasChangedOrientation, hasChangedPosition, hasExplicitlyChangedBlock, hasExplicitlyChangedPosition, isCancelled, setCancelled, setFrom, setTo

Methods inherited from class PlayerEvent

getPlayer

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerTeleportEvent

@Internal
public PlayerTeleportEvent(Player player,
 Location from,
 Location to)

PlayerTeleportEvent

@Internal
public PlayerTeleportEvent(Player player,
 Location from,
 Location to,
 PlayerTeleportEvent.TeleportCause cause)

PlayerTeleportEvent

@Internal
public PlayerTeleportEvent(Player player,
 Location from,
 Location to,
 PlayerTeleportEvent.TeleportCause cause,
 Set<TeleportFlag.Relative> teleportFlags)

Method Details

getCause

public PlayerTeleportEvent.TeleportCause getCause()

Gets the cause of this teleportation event

Returns:

Cause of the event

getRelativeTeleportationFlags

public @Unmodifiable Set<TeleportFlag.Relative> getRelativeTeleportationFlags()

Returns the relative teleportation flags used in this teleportation. This determines which axis the player will not lose their velocity in.

Returns:

an immutable set of relative teleportation flags

willDismountPlayer

@Deprecated(forRemoval=true)
@Contract("-> true")
public boolean willDismountPlayer()

Deprecated, for removal: This API element is subject to removal in a future version.

dismounting on tp is no longer controlled by the server

Gets if the player will be dismounted in this teleportation.

Returns:

dismounted or not

getHandlers

public HandlerList getHandlers()

Overrides:

getHandlers in class PlayerMoveEvent

getHandlerList

public static HandlerList getHandlerList()