Package io.papermc.paper.entity

Enum Class TeleportFlag.Relative

java.lang.Object

java.lang.Enum<TeleportFlag.Relative>

io.papermc.paper.entity.TeleportFlag.Relative

All Implemented Interfaces:

TeleportFlag, Serializable, Comparable<TeleportFlag.Relative>, Constable

Enclosing interface:

TeleportFlag

public static enum TeleportFlag.Relative
extends Enum<TeleportFlag.Relative>
implements TeleportFlag

Note: These flags only work on Player entities.

Represents coordinates in a teleportation that should be handled relatively.

Coordinates of the location that the client should handle as relative teleportation Relative teleportation flags are only used client side, and cause the player to not lose velocity in that specific coordinate. The location of the teleportation will not change.

See Also:

• Entity.teleport(Location, PlayerTeleportEvent.TeleportCause, TeleportFlag...)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface io.papermc.paper.entity.TeleportFlag

TeleportFlag.EntityState, TeleportFlag.Relative

Enum Constant Summary

Enum Constants

Enum Constant	Description
PITCH	Represents the player's pitch
X	Represents the player's X coordinate
Y	Represents the player's Y coordinate
YAW	Represents the player's yaw
Z	Represents the player's Z coordinate

Method Summary

Modifier and Type	Method	Description
static TeleportFlag.Relative	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TeleportFlag.Relative[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

X

public static final TeleportFlag.Relative X

Represents the player's X coordinate

Y

public static final TeleportFlag.Relative Y

Represents the player's Y coordinate

Z

public static final TeleportFlag.Relative Z

Represents the player's Z coordinate

YAW

public static final TeleportFlag.Relative YAW

Represents the player's yaw

PITCH

public static final TeleportFlag.Relative PITCH

Represents the player's pitch

Method Details

values

public static TeleportFlag.Relative[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TeleportFlag.Relative valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null