Package io.papermc.paper.entity

Enum Class TeleportFlag.EntityState

java.lang.Object

java.lang.Enum<TeleportFlag.EntityState>

io.papermc.paper.entity.TeleportFlag.EntityState

All Implemented Interfaces:

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

Enclosing interface:

TeleportFlag

@Experimental
public static enum TeleportFlag.EntityState
extends Enum<TeleportFlag.EntityState>
implements TeleportFlag

Represents flags that effect the entity's state on teleportation.

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
RETAIN_OPEN_INVENTORY	Indicates that a player should not have their current open inventory closed when teleporting.
RETAIN_PASSENGERS	If all passengers should not be required to be removed prior to teleportation.
RETAIN_VEHICLE	If the entity should not be dismounted if they are riding another entity.

Method Summary

Modifier and Type	Method	Description
static TeleportFlag.EntityState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TeleportFlag.EntityState[]	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

RETAIN_PASSENGERS

public static final TeleportFlag.EntityState RETAIN_PASSENGERS

If all passengers should not be required to be removed prior to teleportation.

Note: Teleporting to a different world with this flag present while the entity has entities riding it will cause this teleportation to return false and not occur.

RETAIN_VEHICLE

public static final TeleportFlag.EntityState RETAIN_VEHICLE

If the entity should not be dismounted if they are riding another entity.

Note: Teleporting to a different world with this flag present while this entity is riding another entity will cause this teleportation to return false and not occur.

RETAIN_OPEN_INVENTORY

public static final TeleportFlag.EntityState RETAIN_OPEN_INVENTORY

Indicates that a player should not have their current open inventory closed when teleporting.

Note: This option will be ignored when teleported to a different world.

Method Details

values

public static TeleportFlag.EntityState[] 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.EntityState 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