Interface GenerationDescriptor

All Known Implementing Classes:

GenerationDescriptor.Flat, GenerationDescriptor.Noise, GenerationDescriptor.Unknown

public sealed interface GenerationDescriptor
permits GenerationDescriptor.Flat, GenerationDescriptor.Noise, GenerationDescriptor.Unknown

How a WorldGenerator is described in level.dat, so vanilla tools can make sense of the world.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	GenerationDescriptor.Flat	A superflat world.
static final record	GenerationDescriptor.Noise	A noise-based world.
static final record	GenerationDescriptor.Unknown	A generator that describes nothing.

Method Summary

Static Methods

Modifier and Type	Method	Description
static GenerationDescriptor	flat(Key floorBlock, int floorThickness, Key biome)	Returns a descriptor of a superflat world.
static GenerationDescriptor	noise(Key settings, Key biomeSourcePreset)	Returns a descriptor of a noise-based world.
static GenerationDescriptor	unknown()	Returns a descriptor saying nothing about the generator.

Method Details

unknown

static GenerationDescriptor unknown()

Returns a descriptor saying nothing about the generator.

Returns:

a descriptor saying nothing about the generator

Since:

0.1.0

flat

static GenerationDescriptor flat(Key floorBlock,
 int floorThickness,
 Key biome)

Returns a descriptor of a superflat world.

Parameters:

floorBlock - the block the floor is made of

floorThickness - the number of floor layers

biome - the biome of the whole world

Returns:

a descriptor of a superflat world

Since:

0.1.0

noise

static GenerationDescriptor noise(Key settings,
 Key biomeSourcePreset)

Returns a descriptor of a noise-based world.

Parameters:

settings - the noise settings key, for instance minecraft:overworld

biomeSourcePreset - the biome source preset key

Returns:

a descriptor of a noise-based world

Since:

0.1.0