Package rekit.persistence.level

Enum Class SettingKey

java.lang.Object

java.lang.Enum<SettingKey>

rekit.persistence.level.SettingKey

All Implemented Interfaces:

Serializable, Comparable<SettingKey>, Constable

public enum SettingKey
extends Enum<SettingKey>

This enum defines all valid settings of a LevelDefinition.

Author:

Dominik Fuchss

See Also:

• LevelDefinition.setSetting(SettingKey, String)
• LevelDefinition.getSetting(SettingKey)

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
AUTO_COIN_SPAWN	Indicates whether coins shall automatically spawn (id=autoCoinSpawn).
DO_GAPS	Indicates whether it is allowed to create gaps (only floor) sections between different structures (id=doGaps).
GROUP	The group of the level for arcade grouping (id=group).
INFINITE	Indicates whether the level is infinite (does not end) (id=infinite).
NAME	The name of the level (id=name).
SHUFFLE	Indicates whether the structures can be shuffled (id=shuffle).

Method Summary

Modifier and Type	Method	Description
static final SettingKey	getByString(String id)	Find SettingKey by id.
String	toString()
static SettingKey	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SettingKey[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NAME

public static final SettingKey NAME

The name of the level (id=name).

GROUP

public static final SettingKey GROUP

The group of the level for arcade grouping (id=group).

AUTO_COIN_SPAWN

public static final SettingKey AUTO_COIN_SPAWN

Indicates whether coins shall automatically spawn (id=autoCoinSpawn).

INFINITE

public static final SettingKey INFINITE

Indicates whether the level is infinite (does not end) (id=infinite).

SHUFFLE

public static final SettingKey SHUFFLE

Indicates whether the structures can be shuffled (id=shuffle).

DO_GAPS

public static final SettingKey DO_GAPS

Indicates whether it is allowed to create gaps (only floor) sections between different structures (id=doGaps).

Method Details

values

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

getByString

public static final SettingKey getByString(String id)

Find SettingKey by id.

Parameters:

id - the id

Returns:

the key or null if not found

toString

public String toString()

Overrides:

toString in class Enum<SettingKey>