Class SuperflatGenerator

Hierarchy (View Summary)

TerrainGenerator
- SuperflatGenerator

Index

Constructors

Properties

bedrock dimension dirt grass identifier path properties identifier

Methods

Constructors

constructor

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

Properties

bedrock

bedrock: BlockPermutation<Bedrock> = ...

`Readonly`dimension

dimension: Dimension

The dimension of the generator.

dirt

dirt: BlockPermutation<Dirt> = ...

grass

grass: BlockPermutation<GrassBlock> = ...

`Readonly`identifier

identifier: string = ...

The identifier of the generator.

`Readonly`path

path: string = __filename

`Readonly`properties

properties: TerrainGeneratorProperties = DefaultTerrainGeneratorProperties

The properties of the generator.

`Static` `Readonly`identifier

identifier: "superflat"

The identifier of the generator.

Methods

apply

apply(cx: number, cz: number): Promise<Chunk>
Generates a chunk at the specified coordinates.
Parameters
- cx: number
  The chunk x coordinate.
- cz: number
  The chunk z coordinate.
Returns Promise<Chunk>
Overrides TerrainGenerator.apply
- Defined in packages/core/src/world/generator/superflat.ts:16