Package org.bukkit.event.entity

Enum Class EntityRemoveEvent.Cause

java.lang.Object

java.lang.Enum<EntityRemoveEvent.Cause>

org.bukkit.event.entity.EntityRemoveEvent.Cause

All Implemented Interfaces:

Serializable, Comparable<EntityRemoveEvent.Cause>, Constable

Enclosing class:

EntityRemoveEvent

public static enum EntityRemoveEvent.Cause
extends Enum<EntityRemoveEvent.Cause>

Represents various ways an entity gets removed.

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
DEATH	When an entity dies.
DESPAWN	When an entity does despawn.
DROP	When an entity gets removed because it drops as an item.
ENTER_BLOCK	When an entity gets removed because it enters a block.
EXPLODE	When an entity gets removed because it exploded.
HIT	When an entity gets removed because it hit something.
MERGE	When an entity gets removed because it merges with another one.
OUT_OF_WORLD	When an entity gets removed because it is too far below the world.
PICKUP	When an entity gets removed because it got pickup.
PLAYER_QUIT	When an entity gets removed with a player because the player quits the game.
PLUGIN	When a plugin manually removes an entity.
TRANSFORMATION	When an entity gets removed because it transforms into another one.
UNLOAD	When the chunk an entity is in gets unloaded.

Method Summary

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

DEATH

public static final EntityRemoveEvent.Cause DEATH

When an entity dies.

DESPAWN

public static final EntityRemoveEvent.Cause DESPAWN

When an entity does despawn. This includes mobs which are too far away, items or arrows which lay to long on the ground or area effect cloud.

DROP

public static final EntityRemoveEvent.Cause DROP

When an entity gets removed because it drops as an item. For example, trident or falling sand.

Note: Depending on other factors, such as gamerules, no item will actually drop, the cause, however, will still be drop.

ENTER_BLOCK

public static final EntityRemoveEvent.Cause ENTER_BLOCK

When an entity gets removed because it enters a block. For example, bees or silverfish.

EXPLODE

public static final EntityRemoveEvent.Cause EXPLODE

When an entity gets removed because it exploded. For example, creepers, tnt or firework.

HIT

public static final EntityRemoveEvent.Cause HIT

When an entity gets removed because it hit something. This mainly applies to projectiles.

MERGE

public static final EntityRemoveEvent.Cause MERGE

When an entity gets removed because it merges with another one. For example, items or xp.

OUT_OF_WORLD

public static final EntityRemoveEvent.Cause OUT_OF_WORLD

When an entity gets removed because it is too far below the world. This only applies to entities which get removed immediately, some entities get damage instead.

PICKUP

public static final EntityRemoveEvent.Cause PICKUP

When an entity gets removed because it got pickup. For example, items, arrows, xp or parrots which get on a player shoulder.

PLAYER_QUIT

public static final EntityRemoveEvent.Cause PLAYER_QUIT

When an entity gets removed with a player because the player quits the game. For example, a boat which gets removed with the player when he quits.

PLUGIN

public static final EntityRemoveEvent.Cause PLUGIN

When a plugin manually removes an entity.

TRANSFORMATION

public static final EntityRemoveEvent.Cause TRANSFORMATION

When an entity gets removed because it transforms into another one.

UNLOAD

public static final EntityRemoveEvent.Cause UNLOAD

When the chunk an entity is in gets unloaded.

Method Details

values

public static EntityRemoveEvent.Cause[] 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 EntityRemoveEvent.Cause 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