Package dev.itsharshxd.zentrix.api.elimination

Enum Class EliminationCause

java.lang.Object

java.lang.Enum<EliminationCause>

dev.itsharshxd.zentrix.api.elimination.EliminationCause

All Implemented Interfaces:

Serializable, Comparable<EliminationCause>, Constable

public enum EliminationCause
extends Enum<EliminationCause>

Why a player was eliminated by something other than an ordinary death.

Zentrix uses this only for diagnostics and for the leave reason reported to addons; it never changes what the elimination does, which EliminationOptions decides on its own.

Since:

1.6.0

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
ADMINISTRATIVE	An administrator or a command removed the player from the match.
PLUGIN	An addon eliminated the player for a reason of its own.
SCENARIO	A scenario's own rules ended this player's match — an objective, a countdown, a wager.

Method Summary

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

SCENARIO

public static final EliminationCause SCENARIO

A scenario's own rules ended this player's match — an objective, a countdown, a wager.

ADMINISTRATIVE

public static final EliminationCause ADMINISTRATIVE

An administrator or a command removed the player from the match.

PLUGIN

public static final EliminationCause PLUGIN

An addon eliminated the player for a reason of its own.

Method Details

values

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