org.pepsoft.worldpainter

Enum Dimension.Role

java.lang.Object

java.lang.Enum<Dimension.Role>

org.pepsoft.worldpainter.Dimension.Role

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Dimension.Role>

Enclosing class:

Dimension

public static enum Dimension.Role
extends java.lang.Enum<Dimension.Role>

A role of a Dimension within a game dimension.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAVE_FLOOR A dimension associated with a TunnelLayer floor in cave mode.
DETAIL A detail dimension.
FLOATING_FLOOR A dimension associated with a TunnelLayer floor in floating dimension mode.
MASTER A master dimension that is exported where no detail dimension exists, at 1:16 scale.

Method Summary

Modifier and Type	Method and Description
static Dimension.Role	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Dimension.Role[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DETAIL

public static final Dimension.Role DETAIL

A detail dimension.

MASTER

public static final Dimension.Role MASTER

A master dimension that is exported where no detail dimension exists, at 1:16 scale.

CAVE_FLOOR

public static final Dimension.Role CAVE_FLOOR

A dimension associated with a TunnelLayer floor in cave mode. The Dimension.Anchor.id field is used to associate it with a particular layer.

FLOATING_FLOOR

public static final Dimension.Role FLOATING_FLOOR

A dimension associated with a TunnelLayer floor in floating dimension mode. The Dimension.Anchor.id field is used to associate it with a particular layer.

Method Detail

values

public static Dimension.Role[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Dimension.Role c : Dimension.Role.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Dimension.Role valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null