Enum Class DungeonProcessor.FillEffect

java.lang.Object

java.lang.Enum<DungeonProcessor.FillEffect>

com.github.yellowstonegames.place.DungeonProcessor.FillEffect

All Implemented Interfaces:

Serializable, Comparable<DungeonProcessor.FillEffect>, Constable

Enclosing class:

DungeonProcessor

public static enum DungeonProcessor.FillEffect
extends Enum<DungeonProcessor.FillEffect>

The effects that can be applied to this dungeon. More may be added in future releases.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOULDERS	Boulders strewn about open areas, represented by '#' and treated as walls
GRASS	Grass, represented by '"'
ISLANDS	Islands of ground, '.', surrounded by shallow water, ',', to place in water at evenly spaced points
TRAPS	Traps, represented by '^'
WATER	Water, represented by '~'

Field Summary

Fields

Modifier and Type	Field	Description
static final DungeonProcessor.FillEffect[]	ALL	The cached result of values(), so you can avoid repeatedly allocating FillEffect[] objects.

Method Summary

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

WATER

public static final DungeonProcessor.FillEffect WATER

Water, represented by '~'

TRAPS

public static final DungeonProcessor.FillEffect TRAPS

Traps, represented by '^'

GRASS

public static final DungeonProcessor.FillEffect GRASS

Grass, represented by '"'

BOULDERS

public static final DungeonProcessor.FillEffect BOULDERS

Boulders strewn about open areas, represented by '#' and treated as walls

ISLANDS

public static final DungeonProcessor.FillEffect ISLANDS

Islands of ground, '.', surrounded by shallow water, ',', to place in water at evenly spaced points

Field Details

ALL

public static final DungeonProcessor.FillEffect[] ALL

The cached result of values(), so you can avoid repeatedly allocating FillEffect[] objects. DO NOT MODIFY THIS ARRAY.

Method Details

values

public static DungeonProcessor.FillEffect[] 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 DungeonProcessor.FillEffect 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