Enum Class PotionEffectProvider.RetrievalState

java.lang.Object

java.lang.Enum<PotionEffectProvider.RetrievalState>

org.skriptlang.skript.bukkit.potion.providers.PotionEffectProvider.RetrievalState

All Implemented Interfaces:

Serializable, Comparable<PotionEffectProvider.RetrievalState>, Constable

Enclosing class:

PotionEffectProvider<T>

public static enum PotionEffectProvider.RetrievalState
extends Enum<PotionEffectProvider.RetrievalState>

Describes the type of potion effects being retrieved in a retrieval operation. This is used for distinguishing between active and hidden potion effects, which only apply to LivingEntity.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Obtaining only active effects
BOTH	Obtaining both active and hidden effects.
HIDDEN	Obtaining only hidden effects
UNSET	Unspecified retrieval state.

Method Summary

Modifier and Type	Method	Description
String	displayName()
static PotionEffectProvider.RetrievalState	fromParseTag(String tag)	Utility method for standardized mapping of a parse tag to a retrieval state.
boolean	includesActive()
boolean	includesHidden()
static PotionEffectProvider.RetrievalState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PotionEffectProvider.RetrievalState[]	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

UNSET

public static final PotionEffectProvider.RetrievalState UNSET

Unspecified retrieval state. Behavior will differ depending on retrieval context.

ACTIVE

public static final PotionEffectProvider.RetrievalState ACTIVE

Obtaining only active effects

HIDDEN

public static final PotionEffectProvider.RetrievalState HIDDEN

Obtaining only hidden effects

BOTH

public static final PotionEffectProvider.RetrievalState BOTH

Obtaining both active and hidden effects. A combination of ACTIVE and HIDDEN.

Method Details

values

public static PotionEffectProvider.RetrievalState[] 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 PotionEffectProvider.RetrievalState 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

fromParseTag

public static PotionEffectProvider.RetrievalState fromParseTag(String tag)

Utility method for standardized mapping of a parse tag to a retrieval state.

Parameters:

tag - Parse tag representing a retrieval state.

Returns:

A retrieval state.

includesActive

public boolean includesActive()

Returns:

Whether this state includes active potion effects.

includesHidden

public boolean includesHidden()

Returns:

Whether this state includes hidden potion effects.

displayName

public String displayName()

Returns:

A user-friendly string describing this retrieval state.