org.cloudburstmc.server.level.chunk

Class Chunk

java.lang.Object

org.cloudburstmc.server.level.chunk.Chunk

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<IChunk>, IChunk

@ThreadSafe
 @ParametersAreNonnullByDefault
public final class Chunk
extends Object
implements IChunk, Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static int	SECTION_COUNT

Fields inherited from interface org.cloudburstmc.server.level.chunk.IChunk

STATE_FINISHED, STATE_GENERATED, STATE_NEW, STATE_POPULATED

Constructor Summary

Constructors

Constructor and Description
Chunk(int x, int z, Level level)

Method Summary

Modifier and Type	Method and Description
void	addBlockEntity(BlockEntity blockEntity)
void	addEntity(Entity entity)
void	addLoader(ChunkLoader chunkLoader)
static short	blockKey(int x, int y, int z)
static int	blockKey(int x, int y, int z, int layer)
static short	blockKey(com.nukkitx.math.vector.Vector3i vector)
void	clear() Clear chunk to a state as if it was not generated.
boolean	clearDirty() Atomically resets this chunk's dirty status.
void	close()
com.nukkitx.protocol.bedrock.packet.LevelChunkPacket	createChunkPacket()
static com.nukkitx.math.vector.Vector4i	fromKey(long chunkKey, int blockKey)
static com.nukkitx.math.vector.Vector3i	fromKey(long chunkKey, short blockKey)
static int	fromKeyX(long key)
static int	fromKeyZ(long key)
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.
BlockState	getBlock(int x, int y, int z, int layer)
Set<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<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<ChunkLoader>	getLoaders()
ChunkSection	getOrCreateSection(int y)
Set<Player>	getPlayerLoaders()
Set<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.
void	init()
boolean	isDirty() Whether the chunk has changed since it was last loaded or saved.
static long	key(int x, int z)
LockableChunk	readLockable()
void	removeBlockEntity(BlockEntity blockEntity)
void	removeEntity(Entity entity)
void	removeLoader(ChunkLoader chunkLoader)
void	setBiome(int x, int z, int biome)
void	setBlock(int x, int y, int z, int layer, BlockState blockState)
void	setBlockLight(int x, int y, int z, int level)
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.
void	tick(int tick)
LockableChunk	writeLockable()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cloudburstmc.server.level.chunk.IChunk

compareTo, getAndSetBlock, getBlock, isFinished, isGenerated, isPopulated, key, setBlock, setDirty

Field Detail

SECTION_COUNT

public static final int SECTION_COUNT

See Also:

Constant Field Values

Constructor Detail

Chunk

public Chunk(int x,
             int z,
             Level level)

Method Detail

init

public void init()

getOrCreateSection

@Nonnull
public ChunkSection getOrCreateSection(int y)

Specified by:

getOrCreateSection in interface IChunk

getSection

@Nullable
public ChunkSection getSection(int y)

Specified by:

getSection in interface IChunk

getSections

@Nonnull
public ChunkSection[] getSections()

Specified by:

getSections in interface IChunk

getBlock

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

Specified by:

getBlock in interface IChunk

getAndSetBlock

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

Specified by:

getAndSetBlock in interface IChunk

setBlock

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

Specified by:

setBlock in interface IChunk

getBiome

public int getBiome(int x,
                    int z)

Specified by:

getBiome in interface IChunk

setBiome

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

Specified by:

setBiome in interface IChunk

getSkyLight

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

Specified by:

getSkyLight in interface IChunk

setSkyLight

public void setSkyLight(int x,
                        int y,
                        int z,
                        int level)

Specified by:

setSkyLight in interface IChunk

getBlockLight

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

Specified by:

getBlockLight in interface IChunk

setBlockLight

public void setBlockLight(int x,
                          int y,
                          int z,
                          int level)

Specified by:

setBlockLight in interface IChunk

getHighestBlock

public int getHighestBlock(int x,
                           int z)

Specified by:

getHighestBlock in interface IChunk

addEntity

public void addEntity(@Nonnull
                      Entity entity)

Specified by:

addEntity in interface IChunk

removeEntity

public void removeEntity(Entity entity)

Specified by:

removeEntity in interface IChunk

blockKey

public static short blockKey(com.nukkitx.math.vector.Vector3i vector)

blockKey

public static short blockKey(int x,
                             int y,
                             int z)

fromKey

public static com.nukkitx.math.vector.Vector3i fromKey(long chunkKey,
                                                       short blockKey)

getX

public int getX()

Description copied from interface: IChunk

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

Specified by:

getX in interface IChunk

Returns:

chunk x

getZ

public int getZ()

Description copied from interface: IChunk

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

Specified by:

getZ in interface IChunk

Returns:

chunk z

getLevel

@Nonnull
public Level getLevel()

Description copied from interface: IChunk

Get the level the chunk was loaded in.

Specified by:

getLevel in interface IChunk

Returns:

chunk level

getBiomeArray

@Nonnull
public byte[] getBiomeArray()

Description copied from interface: IChunk

Get the copy of the biome array.

Specified by:

getBiomeArray in interface IChunk

Returns:

biome array

getHeightMapArray

@Nonnull
public int[] getHeightMapArray()

Description copied from interface: IChunk

Get a copy of the height map array.

Specified by:

getHeightMapArray in interface IChunk

Returns:

height map

getPlayers

@Nonnull
public Set<Player> getPlayers()

Description copied from interface: IChunk

Gets an immutable copy of players currently in this chunk

Specified by:

getPlayers in interface IChunk

Returns:

player set

getEntities

@Nonnull
public Set<Entity> getEntities()

Description copied from interface: IChunk

Gets an immutable copy of entities currently in this chunk

Specified by:

getEntities in interface IChunk

Returns:

entity set

fromKey

public static com.nukkitx.math.vector.Vector4i fromKey(long chunkKey,
                                                       int blockKey)

getState

public int getState()

Description copied from interface: IChunk

Gets this chunk's current state.

Specified by:

getState in interface IChunk

setState

public int setState(int next)

Description copied from interface: IChunk

Atomically updates this chunk's state.

Specified by:

setState in interface IChunk

Parameters:

next - the new state to set

Returns:

the chunk's previous state

isDirty

public boolean isDirty()

Description copied from interface: IChunk

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

Specified by:

isDirty in interface IChunk

Returns:

dirty

clearDirty

public boolean clearDirty()

Description copied from interface: IChunk

Atomically resets this chunk's dirty status.

Specified by:

clearDirty in interface IChunk

Returns:

whether or not the chunk was previously dirty

addLoader

public void addLoader(ChunkLoader chunkLoader)

removeLoader

public void removeLoader(ChunkLoader chunkLoader)

getLoaders

@Nonnull
public Set<ChunkLoader> getLoaders()

getPlayerLoaders

@Nonnull
public Set<Player> getPlayerLoaders()

tick

public void tick(int tick)

readLockable

public LockableChunk readLockable()

writeLockable

public LockableChunk writeLockable()

clear

public void clear()

Description copied from interface: IChunk

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

Specified by:

clear in interface IChunk

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

addBlockEntity

public void addBlockEntity(BlockEntity blockEntity)

Specified by:

addBlockEntity in interface IChunk

removeBlockEntity

public void removeBlockEntity(BlockEntity blockEntity)

Specified by:

removeBlockEntity in interface IChunk

blockKey

public static int blockKey(int x,
                           int y,
                           int z,
                           int layer)

getBlockEntity

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

Specified by:

getBlockEntity in interface IChunk

getBlockEntities

@Nonnull
public Set<BlockEntity> getBlockEntities()

Description copied from interface: IChunk

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

Specified by:

getBlockEntities in interface IChunk

Returns:

block entity collection

key

public static long key(int x,
                       int z)

fromKeyX

public static int fromKeyX(long key)

fromKeyZ

public static int fromKeyZ(long key)

setDirty

public void setDirty(boolean dirty)

Description copied from interface: IChunk

Sets the chunk's dirty status.

Specified by:

setDirty in interface IChunk

Parameters:

dirty - true if chunk is dirty

createChunkPacket

@Nonnull
public com.nukkitx.protocol.bedrock.packet.LevelChunkPacket createChunkPacket()