org.cloudburstmc.api.level.chunk

Interface Chunk

All Superinterfaces:

Comparable<Chunk>

All Known Implementing Classes:

LockableChunk

public interface Chunk
extends Comparable<Chunk>

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_FINISHED
static int	STATE_GENERATED
static int	STATE_NEW
static int	STATE_POPULATED

Method Summary

Modifier and Type	Method and Description
void	addBlockEntity(BlockEntity blockEntity)
void	addEntity(Entity entity)
void	clear() Clear chunk to a state as if it was not generated.
boolean	clearDirty() Atomically resets this chunk's dirty status.
void	close()
default int	compareTo(Chunk o)
default BlockState	getAndSetBlock(int x, int y, int z, BlockState blockState)
BlockState	getAndSetBlock(int x, int y, int z, int layer, BlockState blockState)
int	getBiome(int x, int z)
byte[]	getBiomeArray() Get the copy of the biome array.
default BlockState	getBlock(int x, int y, int z)
BlockState	getBlock(int x, int y, int z, int layer)
Set<? extends BlockEntity>	getBlockEntities() Gets an immutable copy of all block entities within the current chunk.
BlockEntity	getBlockEntity(int x, int y, int z)
byte	getBlockLight(int x, int y, int z)
Set<? extends Entity>	getEntities() Gets an immutable copy of entities currently in this chunk
int[]	getHeightMapArray() Get a copy of the height map array.
int	getHighestBlock(int x, int z)
Level	getLevel() Get the level the chunk was loaded in.
Set<? extends ChunkLoader>	getLoaders()
ChunkSection	getOrCreateSection(int y)
Set<? extends Player>	getPlayerLoaders()
Set<? extends Player>	getPlayers() Gets an immutable copy of players currently in this chunk
ChunkSection	getSection(int y)
ChunkSection[]	getSections()
byte	getSkyLight(int x, int y, int z)
int	getState() Gets this chunk's current state.
int	getX() Get the chunk's X coordinate in the level it was loaded.
int	getZ() Get the chunk's Z coordinate in the level it was loaded.
boolean	isDirty() Whether the chunk has changed since it was last loaded or saved.
default boolean	isFinished()
default boolean	isGenerated()
default boolean	isPopulated()
default long	key()
LockableChunk	readLockable()
void	removeBlockEntity(BlockEntity blockEntity)
void	removeEntity(Entity entity)
void	setBiome(int x, int z, int biome)
default void	setBlock(int x, int y, int z, BlockState blockState)
void	setBlock(int x, int y, int z, int layer, BlockState blockState)
void	setBlockLight(int x, int y, int z, int level)
default void	setDirty() Sets the chunk's dirty status.
void	setDirty(boolean dirty) Sets the chunk's dirty status.
void	setSkyLight(int x, int y, int z, int level)
int	setState(int next) Atomically updates this chunk's state.
LockableChunk	writeLockable()

Field Detail

STATE_NEW

static final int STATE_NEW

See Also:

Constant Field Values

STATE_GENERATED

static final int STATE_GENERATED

See Also:

Constant Field Values

STATE_POPULATED

static final int STATE_POPULATED

See Also:

Constant Field Values

STATE_FINISHED

static final int STATE_FINISHED

See Also:

Constant Field Values

Method Detail

getOrCreateSection

@Nonnull
ChunkSection getOrCreateSection(@Nonnegative
                                         int y)

getSection

@Nullable
ChunkSection getSection(@Nonnegative
                                  int y)

getSections

@Nonnull
ChunkSection[] getSections()

getBlock

@Nonnull
default BlockState getBlock(int x,
                                     int y,
                                     int z)

getBlock

@Nonnull
BlockState getBlock(int x,
                             int y,
                             int z,
                             @Nonnegative
                             int layer)

getAndSetBlock

default BlockState getAndSetBlock(int x,
                                  int y,
                                  int z,
                                  BlockState blockState)

getAndSetBlock

BlockState getAndSetBlock(int x,
                          int y,
                          int z,
                          @Nonnegative
                          int layer,
                          BlockState blockState)

setBlock

default void setBlock(int x,
                      int y,
                      int z,
                      BlockState blockState)

setBlock

void setBlock(int x,
              int y,
              int z,
              @Nonnegative
              int layer,
              BlockState blockState)

getBiome

int getBiome(int x,
             int z)

setBiome

void setBiome(int x,
              int z,
              int biome)

getSkyLight

byte getSkyLight(int x,
                 int y,
                 int z)

setSkyLight

void setSkyLight(int x,
                 int y,
                 int z,
                 @Nonnegative
                 int level)

getBlockLight

byte getBlockLight(int x,
                   int y,
                   int z)

setBlockLight

void setBlockLight(int x,
                   int y,
                   int z,
                   @Nonnegative
                   int level)

getHighestBlock

int getHighestBlock(int x,
                    int z)

addEntity

void addEntity(@Nonnull
               Entity entity)

removeEntity

void removeEntity(Entity entity)

addBlockEntity

void addBlockEntity(BlockEntity blockEntity)

removeBlockEntity

void removeBlockEntity(BlockEntity blockEntity)

getBlockEntity

BlockEntity getBlockEntity(int x,
                           int y,
                           int z)

getX

int getX()

Get the chunk's X coordinate in the level it was loaded.

Returns:

chunk x

getZ

int getZ()

Get the chunk's Z coordinate in the level it was loaded.

Returns:

chunk z

getLevel

@Nonnull
Level getLevel()

Get the level the chunk was loaded in.

Returns:

chunk level

getBiomeArray

@Nonnull
byte[] getBiomeArray()

Get the copy of the biome array.

Returns:

biome array

getHeightMapArray

@Nonnull
int[] getHeightMapArray()

Get a copy of the height map array.

Returns:

height map

getPlayers

@Nonnull
Set<? extends Player> getPlayers()

Gets an immutable copy of players currently in this chunk

Returns:

player set

getEntities

@Nonnull
Set<? extends Entity> getEntities()

Gets an immutable copy of entities currently in this chunk

Returns:

entity set

getBlockEntities

@Nonnull
Set<? extends BlockEntity> getBlockEntities()

Gets an immutable copy of all block entities within the current chunk.

Returns:

block entity set

getState

int getState()

Gets this chunk's current state.

setState

int setState(int next)

Atomically updates this chunk's state.

Parameters:

next - the new state to set

Returns:

the chunk's previous state

Throws:

IllegalStateException - if the new state is invalid, or the same as or lower than the current state

isGenerated

default boolean isGenerated()

isPopulated

default boolean isPopulated()

isFinished

default boolean isFinished()

isDirty

boolean isDirty()

Whether the chunk has changed since it was last loaded or saved.

Returns:

dirty

setDirty

default void setDirty()

Sets the chunk's dirty status.

setDirty

void setDirty(boolean dirty)

Sets the chunk's dirty status.

Parameters:

dirty - true if chunk is dirty

clearDirty

boolean clearDirty()

Atomically resets this chunk's dirty status.

Returns:

whether or not the chunk was previously dirty

clear

void clear()

Clear chunk to a state as if it was not generated.

key

default long key()

Returns:

this chunk's key

compareTo

default int compareTo(Chunk o)

Specified by:

compareTo in interface Comparable<Chunk>

readLockable

LockableChunk readLockable()

writeLockable

LockableChunk writeLockable()

close

void close()

getLoaders

Set<? extends ChunkLoader> getLoaders()

getPlayerLoaders

Set<? extends Player> getPlayerLoaders()