Package io.papermc.paper.entity

Enum Class EntitySerializationFlag

java.lang.Object

java.lang.Enum<EntitySerializationFlag>

io.papermc.paper.entity.EntitySerializationFlag

All Implemented Interfaces:

Serializable, Comparable<EntitySerializationFlag>, Constable

public enum EntitySerializationFlag
extends Enum<EntitySerializationFlag>

Represents flags for entity serialization.

Since:

1.21.4

See Also:

• UnsafeValues.serializeEntity(Entity, EntitySerializationFlag...serializationFlags)

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FORCE	Serialize entities that wouldn't be serialized normally (e.g.
MISC	Serialize misc non-saveable entities like lighting bolts, fishing bobbers, etc.
PASSENGERS	Include passengers in the serialized data.
PLAYER	Allow serializing Players.

Method Summary

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

FORCE

public static final EntitySerializationFlag FORCE

Serialize entities that wouldn't be serialized normally (e.g. dead, despawned, non-persistent, etc.).

See Also:

• Entity.isValid()
• Entity.isPersistent()

MISC

public static final EntitySerializationFlag MISC

Serialize misc non-saveable entities like lighting bolts, fishing bobbers, etc.
Note: players require a separate flag: PLAYER.

PASSENGERS

public static final EntitySerializationFlag PASSENGERS

Include passengers in the serialized data.

PLAYER

public static final EntitySerializationFlag PLAYER

Allow serializing Players.

Note: deserializing player data will always fail.

Method Details

values

public static EntitySerializationFlag[] 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 EntitySerializationFlag 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