Enum Class ChunkGenerationState

java.lang.Object

java.lang.Enum<ChunkGenerationState>

io.papermc.paper.world.chunk.ChunkGenerationState

All Implemented Interfaces:

Serializable, Comparable<ChunkGenerationState>, Constable

public enum ChunkGenerationState
extends Enum<ChunkGenerationState>

The generation state of a chunk, as reported by World.getChunkGenerationState(int, int) and World.getChunkGenerationStateAsync(int, int).

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GENERATED	The chunk is fully generated and up to date.
NOT_GENERATED	The chunk is not loaded and has no saved data.
OUTDATED	The chunk has saved data that must be upgraded before it can be loaded, for example because it was saved by an older version, or it has pending world generation from a world height change.
PARTIAL	Generation of the chunk has started but has not completed.

Method Summary

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

NOT_GENERATED

public static final ChunkGenerationState NOT_GENERATED

The chunk is not loaded and has no saved data.

PARTIAL

public static final ChunkGenerationState PARTIAL

Generation of the chunk has started but has not completed. Loading the chunk will complete generation.

OUTDATED

public static final ChunkGenerationState OUTDATED

The chunk has saved data that must be upgraded before it can be loaded, for example because it was saved by an older version, or it has pending world generation from a world height change. Loading the chunk will modify it.

The chunk may be partially or fully generated; generation progress is not determined for chunks in this state, as doing so would require upgrading the chunk data.

GENERATED

public static final ChunkGenerationState GENERATED

The chunk is fully generated and up to date. Loading it will not change it.

Method Details

values

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