Enum Class ScreenEffectEvents.ToggleCause

java.lang.Object

java.lang.Enum<ScreenEffectEvents.ToggleCause>

net.ixdarklord.coolcatcanvas.api.event.v2.client.ScreenEffectEvents.ToggleCause

All Implemented Interfaces:

Serializable, Comparable<ScreenEffectEvents.ToggleCause>, Constable

Enclosing class:

ScreenEffectEvents

public static enum ScreenEffectEvents.ToggleCause
extends Enum<ScreenEffectEvents.ToggleCause>

What turned an effect on or off.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CODE	A mod, through the effect's methods.
CONDITION	Its activeWhen condition.
PLAYER	The player, from the effects screen or a saved choice.
SERVER	The server, through ScreenEffectControl.
TIMEOUT	The end of an enableFor.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CODE

public static final ScreenEffectEvents.ToggleCause CODE

A mod, through the effect's methods.

CONDITION

public static final ScreenEffectEvents.ToggleCause CONDITION

Its activeWhen condition.

TIMEOUT

public static final ScreenEffectEvents.ToggleCause TIMEOUT

The end of an enableFor.

PLAYER

public static final ScreenEffectEvents.ToggleCause PLAYER

The player, from the effects screen or a saved choice.

SERVER

public static final ScreenEffectEvents.ToggleCause SERVER

The server, through ScreenEffectControl.

Method Details

values

public static ScreenEffectEvents.ToggleCause[] 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 ScreenEffectEvents.ToggleCause 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