Class SubChunk

Represents a sub chunk.

Index

Constructors

Properties

index layers version

Methods

getLayer getState isEmpty setState deserialize from serialize

Constructors

constructor

new SubChunk(version?: number, layers?: BlockStorage[]): SubChunk
Creates a new sub chunk.
Parameters
- Optionalversion: number
  The version of the sub chunk.
- Optionallayers: BlockStorage[]
  The layers of the sub chunk.
Returns SubChunk
- Defined in packages/core/src/world/chunk/sub-chunk.ts:30

Properties

index

index: null | number = null

The index of the sub chunk.

`Readonly`layers

layers: BlockStorage[]

The layers of the sub chunk.

`Readonly`version

version: number

The version of the sub chunk.

Methods

getLayer

getLayer(index: number): BlockStorage
Gets the block storage at the given index.
Parameters
- index: number
  The index of the storage.
Returns BlockStorage
The block storage.
- Defined in packages/core/src/world/chunk/sub-chunk.ts:60

getState

getState(bx: number, by: number, bz: number, layer: number): number
Gets the block state at the given coordinates.
Parameters
- bx: number
  The x coordinate of the block.
- by: number
  The y coordinate of the block.
- bz: number
  The z coordinate of the block.
- layer: number
  The layer of the block.
Returns number
The block state.
- Defined in packages/core/src/world/chunk/sub-chunk.ts:82

isEmpty

isEmpty(): boolean
Checks if the sub chunk is empty.

Returns boolean
True if the sub chunk is empty, false otherwise.
- Defined in packages/core/src/world/chunk/sub-chunk.ts:40

setState

setState(
    bx: number,
    by: number,
    bz: number,
    state: number,
    layer?: number,
): void
Sets the block state at the given coordinates.
Parameters
- bx: number
  The x coordinate of the block.
- by: number
  The y coordinate of the block.
- bz: number
  The z coordinate of the block.
- state: number
  The block state.
- Optionallayer: number
  The layer of the block.
Returns void
- Defined in packages/core/src/world/chunk/sub-chunk.ts:99

`Static`deserialize

deserialize(stream: BinaryStream, nbt?: boolean): SubChunk
Deserializes the sub chunk.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- nbt: boolean = false
Returns SubChunk
- Defined in packages/core/src/world/chunk/sub-chunk.ts:151

`Static`from

from(buffer: Buffer, nbt?: boolean): SubChunk
Parameters
- buffer: Buffer
- nbt: boolean = false
Returns SubChunk
- Defined in packages/core/src/world/chunk/sub-chunk.ts:178

`Static`serialize

serialize(subchunk: SubChunk, stream: BinaryStream, nbt?: boolean): void
Serializes the sub chunk.
Parameters
- subchunk: SubChunk
- stream: BinaryStream
  The binary stream to write to.
- nbt: boolean = false
Returns void
- Defined in packages/core/src/world/chunk/sub-chunk.ts:118