org.bukkit
Enum World.Environment

java.lang.Object
  java.lang.Enum<World.Environment>
      org.bukkit.World.Environment

All Implemented Interfaces:

Serializable, Comparable<World.Environment>

Enclosing interface:

World

public static enum World.Environment
extends Enum<World.Environment>

Represents various map environment types that a world may be

Enum Constant Summary

NETHER
Represents a nether based map ("hell")

NORMAL
Represents the "normal"/"surface world" map

THE_END
Represents the "end" map

Method Summary

static World.Environment	getEnvironment(int id) Get an environment by ID
int	getId() Gets the dimension ID of this environment
static World.Environment	valueOf(String name) Returns the enum constant of this type with the specified name.
static World.Environment[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORMAL

public static final World.Environment NORMAL

Represents the "normal"/"surface world" map

NETHER

public static final World.Environment NETHER

Represents a nether based map ("hell")

THE_END

public static final World.Environment THE_END

Represents the "end" map

Method Detail

values

public static final World.Environment[] values()

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

for(World.Environment c : World.Environment.values())
        System.out.println(c);

Returns:

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

valueOf

public static World.Environment valueOf(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:

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

getId

public int getId()

Gets the dimension ID of this environment

Returns:

dimension ID

getEnvironment

public static World.Environment getEnvironment(int id)

Get an environment by ID

Parameters:

id - The ID of the environment

Returns:

The environment