org.spongepowered.api.world

Enum ChunkState

java.lang.Object

java.lang.Enum<ChunkState>

org.spongepowered.api.world.ChunkState

All Implemented Interfaces:

Serializable, Comparable<ChunkState>

public enum ChunkState
extends Enum<ChunkState>

Represents the state of a Chunk.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOADED The chunk is fully generated and loaded into the world.
NOT_GENERATED The chunk is loaded but has not yet been generated.
NOT_POPULATED The chunk has been generated (implying that the shape of the terrain has been formed out of a basic block) but none of the populators or structures have been applied yet.
UNLOADED The chunk is not loaded into memory.

Method Summary

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

UNLOADED

public static final ChunkState UNLOADED

The chunk is not loaded into memory. Whether the chunk has been generated is unknown while in this state.

NOT_GENERATED

public static final ChunkState NOT_GENERATED

The chunk is loaded but has not yet been generated.

NOT_POPULATED

public static final ChunkState NOT_POPULATED

The chunk has been generated (implying that the shape of the terrain has been formed out of a basic block) but none of the populators or structures have been applied yet.

LOADED

public static final ChunkState LOADED

The chunk is fully generated and loaded into the world.

Method Detail

values

public static ChunkState[] 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 (ChunkState c : ChunkState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ChunkState 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

NullPointerException - if the argument is null