Package ch.njol.skript.lang

Enum Class SkriptEvent.ListeningBehavior

java.lang.Object

java.lang.Enum<SkriptEvent.ListeningBehavior>

ch.njol.skript.lang.SkriptEvent.ListeningBehavior

All Implemented Interfaces:

Serializable, Comparable<SkriptEvent.ListeningBehavior>, Constable

Enclosing class:

SkriptEvent

public static enum SkriptEvent.ListeningBehavior
extends Enum<SkriptEvent.ListeningBehavior>

The listening behavior of a Skript event. This determines whether the event should run for cancelled events, uncancelled events, or both.

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
ANY	This Skript event should run for any event, cancelled or uncancelled.
CANCELLED	This Skript event should run for any cancelled event.
UNCANCELLED	This Skript event should run for any uncancelled event.

Method Summary

Modifier and Type	Method	Description
boolean	matches(boolean cancelled)	Checks whether this listening behavior matches the given cancelled state.
static SkriptEvent.ListeningBehavior	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SkriptEvent.ListeningBehavior[]	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

UNCANCELLED

public static final SkriptEvent.ListeningBehavior UNCANCELLED

This Skript event should run for any uncancelled event.

CANCELLED

public static final SkriptEvent.ListeningBehavior CANCELLED

This Skript event should run for any cancelled event.

ANY

public static final SkriptEvent.ListeningBehavior ANY

This Skript event should run for any event, cancelled or uncancelled.

Method Details

values

public static SkriptEvent.ListeningBehavior[] 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 SkriptEvent.ListeningBehavior 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

matches

public boolean matches(boolean cancelled)

Checks whether this listening behavior matches the given cancelled state.

Parameters:

cancelled - Whether the event is cancelled.

Returns:

Whether an event with the given cancelled state should be run for this listening behavior.