Class Structure

Represents a block storage.

Hierarchy (View Summary)

BlockStorage
- Structure

Index

Constructors

constructor

new Structure(options?: Partial<StructureOptions>): Structure
Parameters
- Optionaloptions: Partial<StructureOptions>
Returns Structure
Overrides BlockStorage.constructor
- Defined in packages/core/src/world/structure.ts:36

Properties

`Readonly`air

air: number

The air value of the storage.

`Readonly`blocks

blocks: number[]

The blocks of the storage.

`Readonly`palette

palette: number[]

The palette of the storage.

`Readonly`size

size: [number, number, number] = ...

The size of the block storage.

`Static` `Readonly`MAX_SIZE

MAX_SIZE: number = ...

The total maximum chunk size.

`Static` `Readonly`MAX_X

MAX_X: 16

The maximum chunk size in the x direction.

`Static` `Readonly`MAX_Y

MAX_Y: 16

The maximum chunk size in the y direction.

`Static` `Readonly`MAX_Z

MAX_Z: 16

The maximum chunk size in the z direction.

Methods

getIndex

getIndex(bx: number, by: number, bz: number): number
Calculates the index of the block position.
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.
Returns number
The index of the block.
Inherited from BlockStorage.getIndex
- Defined in packages/core/src/world/chunk/block-storage.ts:141

getState

getState(bx: number, by: number, bz: 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.
Returns number
The block state.
Inherited from BlockStorage.getState
- Defined in packages/core/src/world/chunk/block-storage.ts:102

isEmpty

isEmpty(): boolean
Checks if the block storage is empty.

Returns boolean
Inherited from BlockStorage.isEmpty
- Defined in packages/core/src/world/chunk/block-storage.ts:90

setState

setState(bx: number, by: number, bz: number, state: 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.
Returns void
Inherited from BlockStorage.setState
- Defined in packages/core/src/world/chunk/block-storage.ts:121

`Static`deserialize

deserialize(stream: BinaryStream, nbt?: boolean): BlockStorage
Deserializes the block storage from a binary stream.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- nbt: boolean = false
Returns BlockStorage
The block storage.
Inherited from BlockStorage.deserialize
- Defined in packages/core/src/world/chunk/block-storage.ts:254

`Static`from

from(world: World, compound: CompoundTag): Structure
Parameters
- world: World
- compound: CompoundTag
Returns Structure
- Defined in packages/core/src/world/structure.ts:46

`Static`serialize

serialize(storage: BlockStorage, stream: BinaryStream, nbt?: boolean): void
Serializes the block storage to a binary stream.
Parameters
- storage: BlockStorage
- stream: BinaryStream
  The binary stream to write to.
- nbt: boolean = false
Returns void
Inherited from BlockStorage.serialize
- Defined in packages/core/src/world/chunk/block-storage.ts:156

Class Structure

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Structure

Properties

Readonlyair

Readonlyblocks

Readonlypalette

Readonlysize

Static ReadonlyMAX_SIZE

Static ReadonlyMAX_X

Static ReadonlyMAX_Y

Static ReadonlyMAX_Z

Methods

getIndex

Parameters

Returns number

getState

Parameters

Returns number

isEmpty

Returns boolean

setState

Parameters

Returns void

Staticdeserialize

Parameters

Returns BlockStorage

Staticfrom

Parameters

Returns Structure

Staticserialize

Parameters

Returns void

Settings

On This Page

`Readonly`air

`Readonly`blocks

`Readonly`palette

`Readonly`size

`Static` `Readonly`MAX_SIZE

`Static` `Readonly`MAX_X

`Static` `Readonly`MAX_Y

`Static` `Readonly`MAX_Z

`Static`deserialize

`Static`from

`Static`serialize