Class Chunk

Represents a chunk within a Dimension instance. Chunks hold sub chunks, which hold block states (BlockPermutations). Chunks can be dirty, meaning they have been modified and need to be saved.

Example Usage

	import { BlockIdentifier, BlockPermutation } from "@serenityjs/block"
import { DimensionType } from "@serenityjs/protocol"
import { Chunk } from "@serenityjs/world"

// Create a new chunk with the dimension type "Overworld" and the x and z coordinates of 0
const chunk = new Chunk(DimensionType.Overworld, 0, 0) // DimensionType will determine the maximum height of the chunk

// First we need to obtain the BlockPermutations we will use to set the blocks
const bedrock = BlockPermutation.resolve(BlockIdentifier.Bedrock)
const dirt = BlockPermutation.resolve(BlockIdentifier.Dirt, { dirt_type: "normal" })
const grass = BlockPermutation.resolve(BlockIdentifier.GrassBlock)

// We can now set a block at the x, y, and z coordinates of the chunk
// We will create a Superflat chunk with a maximum height of 4
for (let x = 0; x < 16; x++) {
	for (let z = 0; z < 16; z++) {
		for (let y = 0; y < 4; y++) {
			// Check if the y coordinate is 0, if so, set the block to bedrock
			if (y === 0) chunk.setPermutation(x, y, z, bedrock)

			// Check if the y coordinate is 1 and 2, if so, set the block to dirt
			else if (y === 1 || y === 2) chunk.setPermutation(x, y, z, dirt)

			// Check if the y coordinate is 3, if so, set the block to grass
			else if (y === 3) chunk.setPermutation(x, y, z, grass)
		}
	}
}

Constructors

constructor

new Chunk(
    x: number,
    z: number,
    type: DimensionType,
    subchunks?: SubChunk[],
): Chunk
Creates a new chunk.
Parameters
- x: number
  The X coordinate of the chunk.
- z: number
  The Z coordinate of the chunk.
- type: DimensionType
  The dimension type of the chunk.
- Optionalsubchunks: SubChunk[]
  The sub chunks of the chunk.
Returns Chunk
- Defined in packages/core/src/world/chunk/chunk.ts:116

Properties

cache

cache: null | Buffer<ArrayBufferLike> = null

A cached buffer of the serialized chunk.

dirty

dirty: boolean = false

If the chunk has been modified, and has not been saved.

`Readonly`hash

hash: bigint

The hash key of the chunk.

ready

ready: boolean = true

If the chunk is ready to be sent to the client.

`Readonly`subchunks

subchunks: SubChunk[]

The sub chunks of the chunk.

`Readonly`type

type: DimensionType

The dimension type of the chunk.

`Readonly`x

x: number

The X coordinate of the chunk.

`Readonly`z

z: number

The Z coordinate of the chunk.

`Static` `Readonly`MAX_SUB_CHUNKS

MAX_SUB_CHUNKS: 24

The maximum amount of sub chunks.

Methods

getAllBlockStorages

getAllBlockStorages(): BlockLevelStorage[]
Get all the block storage of the chunk.

Returns BlockLevelStorage[]
An array of all the block storage compound tags.
- Defined in packages/core/src/world/chunk/chunk.ts:332

getAllEntityStorages

getAllEntityStorages(): [bigint, CompoundTag][]
Returns [bigint, CompoundTag][]
- Defined in packages/core/src/world/chunk/chunk.ts:391

getBiome

getBiome(position: IPosition): BiomeType
Get the biome at the given position.
Parameters
- position: IPosition
  The block position to get the biome at.
Returns BiomeType
The biome at the given block position.
- Defined in packages/core/src/world/chunk/chunk.ts:184

getBlockStorage

getBlockStorage(position: IPosition): null | BlockLevelStorage
Get the block storage at the given position.
Parameters
- position: IPosition
  The position to get the block storage at.
Returns null | BlockLevelStorage
The block storage compound tag, or null if none exists.
- Defined in packages/core/src/world/chunk/chunk.ts:354

getBottommostLevel

getBottommostLevel(position: IPosition): number
Get the bottommost level in which a permutation is not air, at the given X and Z coordinates.
Parameters
- position: IPosition
  The position to query.
Returns number
The bottommost level in which a permutation is not air.
- Defined in packages/core/src/world/chunk/chunk.ts:249

getEntityStorage

getEntityStorage(uniqueId: bigint): null | CompoundTag
Parameters
- uniqueId: bigint
Returns null | CompoundTag
- Defined in packages/core/src/world/chunk/chunk.ts:399

getPermutation

getPermutation(position: IPosition, layer?: number): BlockPermutation
Get the permutation at the given X, Y and Z coordinates.
Parameters
- position: IPosition
  The position.
- layer: number = 0
  The state layer.
Returns BlockPermutation
- Defined in packages/core/src/world/chunk/chunk.ts:134

getSubChunk

getSubChunk(index: number): SubChunk
Get the sub chunk at the given index.
Parameters
- index: number
  The index.
Returns SubChunk
- Defined in packages/core/src/world/chunk/chunk.ts:264

getSubChunkSendCount

getSubChunkSendCount(): number
Get the amount of sub chunks that need to be sent.

Returns number
- Defined in packages/core/src/world/chunk/chunk.ts:311

getTopmostLevel

getTopmostLevel(position: IPosition): number
Get the topmost level in which a permutation is not air, at the given X and Z coordinates.
Parameters
- position: IPosition
  The position to query.
Returns number
The topmost level in which a permutation is not air.
- Defined in packages/core/src/world/chunk/chunk.ts:226

hasBlockStorage

hasBlockStorage(position: IPosition): boolean
Check if the chunk has block storage at the given position.
Parameters
- position: IPosition
  The position to check for block storage.
Returns boolean
True if the chunk has block storage at the given position, false otherwise.
- Defined in packages/core/src/world/chunk/chunk.ts:341

hasEntityStorage

hasEntityStorage(uniqueId: bigint): boolean
Parameters
- uniqueId: bigint
Returns boolean
- Defined in packages/core/src/world/chunk/chunk.ts:395

insert

insert(source: Chunk): Chunk
Insert a chunk into the current chunk.
Parameters
- source: Chunk
  The chunk to insert.
Returns Chunk
The current chunk with the updated sub chunks.
- Defined in packages/core/src/world/chunk/chunk.ts:439

isEmpty

isEmpty(): boolean
Check if the chunk is empty.

Returns boolean
- Defined in packages/core/src/world/chunk/chunk.ts:420

setBiome

setBiome(position: IPosition, biome: BiomeType, dirty?: boolean): void
Set the biome at the given position.
Parameters
- position: IPosition
  The block position to set the biome at.
- biome: BiomeType
  The biome type to set at the given block position.
- dirty: boolean = true
  If the chunk should be marked as dirty. Default is true.
Returns void
- Defined in packages/core/src/world/chunk/chunk.ts:204

setBlockStorage

setBlockStorage(
    position: IPosition,
    data: null | BlockLevelStorage,
    dirty?: boolean,
): void
Set the block storage at the given block position.
Parameters
- position: IPosition
  The block position to set the block storage at.
- data: null | BlockLevelStorage
  The block storage compound tag, or null to delete the block storage.
- dirty: boolean = true
  If the chunk should be marked as dirty. Default is true.
Returns void
- Defined in packages/core/src/world/chunk/chunk.ts:368

setEntityStorage

setEntityStorage(
    uniqueId: bigint,
    data: null | CompoundTag,
    dirty?: boolean,
): void
Parameters
- uniqueId: bigint
- data: null | CompoundTag
- dirty: boolean = true
Returns void
- Defined in packages/core/src/world/chunk/chunk.ts:403

setPermutation

setPermutation(
    position: IPosition,
    permutation: BlockPermutation,
    layer?: number,
    dirty?: boolean,
): void
Set the permutation at the given X, Y and Z coordinates.
Parameters
- position: IPosition
  The position.
- permutation: BlockPermutation
  The permutation.
- layer: number = 0
  The state layer.
- dirty: boolean = true
Returns void
- Defined in packages/core/src/world/chunk/chunk.ts:154

`Static`deserialize

deserialize(
    type: DimensionType,
    x: number,
    z: number,
    buffer: Buffer,
    nbt?: boolean,
): Chunk
Deserialize a buffer into a chunk.
Parameters
- type: DimensionType
  The dimension type of the chunk.
- x: number
  The X coordinate of the chunk.
- z: number
  The Z coordinate of the chunk.
- buffer: Buffer
  The buffer to deserialize.
- nbt: boolean = false
  If block palette should be deserialized as NBT.
Returns Chunk
The deserialized chunk.
- Defined in packages/core/src/world/chunk/chunk.ts:534

`Static`serialize

serialize(chunk: Chunk, nbt?: boolean): Buffer
Serialize the chunk into a buffer.
Parameters
- chunk: Chunk
  The chunk to serialize.
- nbt: boolean = false
  If block palette should be serialized as NBT.
Returns Buffer
The serialized buffer.
- Defined in packages/core/src/world/chunk/chunk.ts:469

Class Chunk

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Chunk

Properties

cache

dirty

Readonlyhash

ready

Readonlysubchunks

Readonlytype

Readonlyx

Readonlyz

Static ReadonlyMAX_SUB_CHUNKS

Methods

getAllBlockStorages

Returns BlockLevelStorage[]

getAllEntityStorages

Returns [bigint, CompoundTag][]

getBiome

Parameters

Returns BiomeType

getBlockStorage

Parameters

Returns null | BlockLevelStorage

getBottommostLevel

Parameters

Returns number

getEntityStorage

Parameters

Returns null | CompoundTag

getPermutation

Parameters

Returns BlockPermutation

getSubChunk

Parameters

Returns SubChunk

getSubChunkSendCount

Returns number

getTopmostLevel

Parameters

Returns number

hasBlockStorage

Parameters

Returns boolean

hasEntityStorage

Parameters

Returns boolean

insert

Parameters

Returns Chunk

isEmpty

Returns boolean

setBiome

Parameters

Returns void

setBlockStorage

Parameters

Returns void

setEntityStorage

Parameters

Returns void

setPermutation

Parameters

Returns void

Staticdeserialize

Parameters

Returns Chunk

Staticserialize

Parameters

Returns Buffer

Settings

On This Page

`Readonly`hash

`Readonly`subchunks

`Readonly`type

`Readonly`x

`Readonly`z

`Static` `Readonly`MAX_SUB_CHUNKS

`Static`deserialize

`Static`serialize