Class TerrainGenerator

Hierarchy (View Summary)

TerrainGenerator
- VoidGenerator
- SuperflatGenerator

Index

Constructors

Properties

dimension identifier properties queue worker identifier worker

Methods

apply handoff populate?

Constructors

constructor

new TerrainGenerator(
dimension: Dimension,
properties?: Partial<TerrainGeneratorProperties>,
): TerrainGenerator
Creates a new terrain generator with the specified properties.
Parameters
- dimension: Dimension
- Optionalproperties: Partial<TerrainGeneratorProperties>
  The properties to use for the generator.
Returns TerrainGenerator
- Defined in packages/core/src/world/generator/generator.ts:66

Properties

`Readonly`dimension

dimension: Dimension

The dimension of the generator.

`Readonly`identifier

identifier: string = ...

The identifier of the generator.

`Readonly`properties

properties: TerrainGeneratorProperties = DefaultTerrainGeneratorProperties

The properties of the generator.

`Readonly`queue

queue: Map<bigint, (value: Chunk) => void> = ...

The chunk queue for the generator.

`Readonly`worker

worker: null | Worker = null

The worker thread for the generator, if applicable.

`Static` `Readonly`identifier

identifier: string

The identifier of the generator.

`Static`worker

worker: null | typeof TerrainWorker = null

The terrain worker for the generator, if applicable.

Methods

apply

apply(_cx: number, _cz: number): Promise<Chunk>
Generates a chunk at the specified coordinates.
Parameters
- _cx: number
- _cz: number
Returns Promise<Chunk>
- Defined in packages/core/src/world/generator/generator.ts:118

`Protected`handoff

handoff(cx: number, cz: number): Promise<Chunk>
Hands off the chunk generation to the worker thread.
Parameters
- cx: number
  The chunk x coordinate.
- cz: number
  The chunk z coordinate.
Returns Promise<Chunk>
A promise that resolves with the generated chunk.
- Defined in packages/core/src/world/generator/generator.ts:128

`Optional`populate

populate(_chunk: Chunk): Promise<void>
Called after a chunk is generated to populate it with features.
Parameters
- _chunk: Chunk
Returns Promise<void>
- Defined in packages/core/src/world/generator/generator.ts:173