Interface BootstrapBiomeRegistry

@NullMarked
@AsOf("2.3.0")
@Experimental
public interface BootstrapBiomeRegistry

Registers custom biomes during the Paper bootstrap/registry-load phase, so they enter the biome registry before it freezes (no post-freezing). A biome that fails to build should fail server startup.

Since:

2.3.0

Field Summary

Fields

Modifier and Type	Field	Description
static final WireProvider<BootstrapBiomeRegistry>	DATAPACK
static final WireProvider<BootstrapBiomeRegistry>	UNSAFE

Method Summary

Modifier and Type	Method	Description
BootstrapBiomeRegistry	addToDimension(ResourceKey dimension, ResourceKey target, ClimatePoint placement)	Adds a biome to a dimension's biome distribution.
static BootstrapBiomeRegistry	compose(BootstrapContext context, Composer type)	Composes a new BootstrapBiomeRegistry instance.
static BootstrapBiomeRegistry	datapack()	Creates a new DatapackBootstrapBiomeRegistry instance.
BootstrapBiomeRegistry	deferring(ThrowingRunnable runnable)	Defers the execution of a runnable until the registry is installed.
static BootstrapBiomeRegistry	injector()	Creates a new UnsafePaperBootstrapBiomeRegistry instance.
BootstrapBiomeRegistry	install(BootstrapContext context)	Installs the registry into the given context.
BootstrapBiomeRegistry	queue(Biome biome)	Queues a biome to be registered.
BootstrapBiomeRegistry	replaceInDimension(ResourceKey dimension, ResourceKey target, ResourceKey replacement)	Replaces a biome in a dimension.

Field Details

UNSAFE

@Internal
static final WireProvider<BootstrapBiomeRegistry> UNSAFE

DATAPACK

@Internal
static final WireProvider<BootstrapBiomeRegistry> DATAPACK

Method Details

compose

@AsOf("2.3.0")
static BootstrapBiomeRegistry compose(BootstrapContext context,
 Composer type)

Composes a new BootstrapBiomeRegistry instance.

Parameters:

context - the bootstrap context

type - the type of registry to compose

Returns:

a new BootstrapBiomeRegistry instance

Since:

2.3.0

See Also:

• Composer

injector

@AsOf("2.3.0")
static BootstrapBiomeRegistry injector()

Creates a new UnsafePaperBootstrapBiomeRegistry instance.

Returns:

a new instance of UnsafePaperBootstrapBiomeRegistry

Since:

2.3.0

datapack

@AsOf("2.3.0")
static BootstrapBiomeRegistry datapack()

Creates a new DatapackBootstrapBiomeRegistry instance.

Returns:

a new instance of DatapackBootstrapBiomeRegistry

Since:

2.3.0

install

@AsOf("2.3.0")
BootstrapBiomeRegistry install(BootstrapContext context)

Installs the registry into the given context.

Parameters:

context - the context to install the registry into

Since:

2.3.0

queue

@AsOf("2.3.0")
BootstrapBiomeRegistry queue(Biome biome)

Queues a biome to be registered.

Parameters:

biome - the biome to register

Since:

2.3.0

deferring

@AsOf("2.3.0")
BootstrapBiomeRegistry deferring(ThrowingRunnable runnable)

Defers the execution of a runnable until the registry is installed.

Parameters:

runnable - the runnable to defer

Returns:

this registry instance

Since:

2.3.0

addToDimension

@AsOf("2.3.0")
BootstrapBiomeRegistry addToDimension(ResourceKey dimension,
 ResourceKey target,
 ClimatePoint placement)
                               throws UnsupportedOperationException

Adds a biome to a dimension's biome distribution. The biome will be added at the specified climate point and may replace an existing biome if the point overlaps with an existing one.

Parameters:

dimension - the dimension to add the biome to

target - the biome to add

placement - the climate point to place the biome at

Returns:

this registry instance

Throws:

UnsupportedOperationException - if the implementation does not support this operation

Since:

2.3.0

See Also:

• LevelStemEditor.addToDimension(ResourceKey, ResourceKey, ClimatePoint)

replaceInDimension

@AsOf("2.3.0")
BootstrapBiomeRegistry replaceInDimension(ResourceKey dimension,
 ResourceKey target,
 ResourceKey replacement)
                                   throws UnsupportedOperationException

Replaces a biome in a dimension.

Parameters:

dimension - the dimension to replace the biome in

target - the biome to replace

replacement - the biome to replace with

Returns:

this registry instance

Throws:

UnsupportedOperationException - if the implementation does not support this operation

Since:

2.3.0

See Also:

• LevelStemEditor.replaceInDimension(ResourceKey, ResourceKey, ResourceKey)