Package org.spongepowered.api.world.chunk

Class ChunkStates

java.lang.Object

org.spongepowered.api.world.chunk.ChunkStates

public final class ChunkStates
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultedRegistryReference<ChunkState>	BIOMES	A Chunk that is having its biomes assigned.
static final DefaultedRegistryReference<ChunkState>	CARVERS	A Chunk that is being "carved out" for general terrain features that require things like "caves" or "canyons".
static final DefaultedRegistryReference<ChunkState>	EMPTY	Identifies a Chunk that is considered empty.
static final DefaultedRegistryReference<ChunkState>	FEATURES	A Chunk has been carved out, and is now being decorated with features, such as leaves and tall grass.
static final DefaultedRegistryReference<ChunkState>	FULL	State for a Chunk marking it being used by a world, and not in the process of either world generation, or deserialization from storage.
static final DefaultedRegistryReference<ChunkState>	HEIGHTMAPS	A Chunk state that is "cleaning" up remnant objects of a chunk in process of world generation.
static final DefaultedRegistryReference<ChunkState>	LIGHT	A Chunk state that has yet been processed with lighting in respects to the WorldLike that contains it.
static final DefaultedRegistryReference<ChunkState>	LIQUID_CARVERS	A Chunk state that is being "carved" with liquid cave features, such as underwater ravines, underwater caves, etc.
static final DefaultedRegistryReference<ChunkState>	NOISE	A Chunk where the block states are being set and structure locations are set.
static final DefaultedRegistryReference<ChunkState>	SPAWN	A Chunk state that is being used for entity spawning.
static final DefaultedRegistryReference<ChunkState>	STRUCTURE_REFERENCES	A Chunk where final validity checks are being performed on structures that are primed to be placed in the chunk.
static final DefaultedRegistryReference<ChunkState>	STRUCTURE_STARTS	A Chunk where the structures to be placed in the chunk are being determined and primed for placement.
static final DefaultedRegistryReference<ChunkState>	SURFACE	A Chunk that is at this state means that it is being generated with a "base" layer of terrain.

Method Summary

Modifier and Type	Method	Description
static Registry<ChunkState>	registry()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BIOMES

public static final DefaultedRegistryReference<ChunkState> BIOMES

A Chunk that is having its biomes assigned.

CARVERS

public static final DefaultedRegistryReference<ChunkState> CARVERS

A Chunk that is being "carved out" for general terrain features that require things like "caves" or "canyons".

EMPTY

public static final DefaultedRegistryReference<ChunkState> EMPTY

Identifies a Chunk that is considered empty. The method Chunk.isEmpty() would return true. Identifies the chunk has nothing contained within it, but can be used as a dummy chunk in some regards for world generation.

FEATURES

public static final DefaultedRegistryReference<ChunkState> FEATURES

A Chunk has been carved out, and is now being decorated with features, such as leaves and tall grass.

FULL

public static final DefaultedRegistryReference<ChunkState> FULL

State for a Chunk marking it being used by a world, and not in the process of either world generation, or deserialization from storage. Only WorldChunks should provide this state, other Chunks would be invalid with this state.

HEIGHTMAPS

public static final DefaultedRegistryReference<ChunkState> HEIGHTMAPS

A Chunk state that is "cleaning" up remnant objects of a chunk in process of world generation. Generally, height maps are being calculated at this point as entity spawning can affect block placement.

LIGHT

public static final DefaultedRegistryReference<ChunkState> LIGHT

A Chunk state that has yet been processed with lighting in respects to the WorldLike that contains it. This is the second to last step in the world generation pipeline for a chunk to be marked as ready for being added to a World.

LIQUID_CARVERS

public static final DefaultedRegistryReference<ChunkState> LIQUID_CARVERS

A Chunk state that is being "carved" with liquid cave features, such as underwater ravines, underwater caves, etc.

NOISE

public static final DefaultedRegistryReference<ChunkState> NOISE

A Chunk where the block states are being set and structure locations are set.

SPAWN

public static final DefaultedRegistryReference<ChunkState> SPAWN

A Chunk state that is being used for entity spawning. Generally requires that the neighboring chunks are adequately populated, and requires that this chunk has proper lighting, for mob placement logic.

STRUCTURE_REFERENCES

public static final DefaultedRegistryReference<ChunkState> STRUCTURE_REFERENCES

A Chunk where final validity checks are being performed on structures that are primed to be placed in the chunk.

STRUCTURE_STARTS

public static final DefaultedRegistryReference<ChunkState> STRUCTURE_STARTS

A Chunk where the structures to be placed in the chunk are being determined and primed for placement.

SURFACE

public static final DefaultedRegistryReference<ChunkState> SURFACE

A Chunk that is at this state means that it is being generated with a "base" layer of terrain.

The chunk should not have any Entity instances or BlockEntity instances and may have a valid WorldLike used for world generation.

Method Details

registry

public static Registry<ChunkState> registry()