Enum Class RemoveReason

java.lang.Object

java.lang.Enum<RemoveReason>

com.hypixel.hytale.component.RemoveReason

All Implemented Interfaces:

Serializable, Comparable<RemoveReason>, Constable

public enum RemoveReason
extends Enum<RemoveReason>

Determines the reason why an entity was removed from the world.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUILDER_TOOLS_UNDO	The entity was removed as part of a builder tools undo operation.
REMOVE	The entity was removed using a removal mechanism.
UNLOAD	The entity was unloaded from memory, typically due to chunk unloading.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REMOVE

public static final RemoveReason REMOVE

The entity was removed using a removal mechanism.

UNLOAD

public static final RemoveReason UNLOAD

The entity was unloaded from memory, typically due to chunk unloading.

BUILDER_TOOLS_UNDO

public static final RemoveReason BUILDER_TOOLS_UNDO

The entity was removed as part of a builder tools undo operation. Spawned entities managed by this entity (e.g. NPCs from spawn markers) should also be removed, since the managing entity is being undone and will no longer own them.

Method Details

values

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