Package dev.itsharshxd.zentrix.api.scenario

Enum Class ScenarioSettingSource

java.lang.Object

java.lang.Enum<ScenarioSettingSource>

dev.itsharshxd.zentrix.api.scenario.ScenarioSettingSource

All Implemented Interfaces:

Serializable, Comparable<ScenarioSettingSource>, Constable

public enum ScenarioSettingSource
extends Enum<ScenarioSettingSource>

Where a resolved scenario setting value came from.

The order here is the resolution order: the first source that supplies a value wins.

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
ARENA_OVERRIDE	An override stored on the source arena.
DEFAULT	The scenario's own declared default; nothing was configured.
GLOBAL	The global value in scenarios.yml.
LOBBY_OVERRIDE	A temporary override applied to one match, normally from the waiting lobby or an addon.

Method Summary

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

LOBBY_OVERRIDE

public static final ScenarioSettingSource LOBBY_OVERRIDE

A temporary override applied to one match, normally from the waiting lobby or an addon.

ARENA_OVERRIDE

public static final ScenarioSettingSource ARENA_OVERRIDE

An override stored on the source arena.

GLOBAL

public static final ScenarioSettingSource GLOBAL

The global value in scenarios.yml.

DEFAULT

public static final ScenarioSettingSource DEFAULT

The scenario's own declared default; nothing was configured.

Method Details

values

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