Interface BootstrapDimensionRegistry

@NullMarked
@AsOf("3.0.0")
@Experimental
public interface BootstrapDimensionRegistry

Registers custom dimension types during the Paper bootstrap/registry-load phase, so they enter the dimension-type registry before it freezes.

Since:

3.0.0

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BootstrapDimensionRegistry	compose(BootstrapContext context, Composer type)	Composes a new datapack-backed BootstrapDimensionRegistry and installs it into the context.
static BootstrapDimensionRegistry	datapack()	Creates a new DatapackBootstrapDimensionRegistry instance.
BootstrapDimensionRegistry	deferring(ThrowingRunnable runnable)	Defers the execution of a runnable until the registry is installed.
BootstrapDimensionRegistry	install(BootstrapContext context)	Installs the registry into the given context.
BootstrapDimensionRegistry	queue(Dimension dimension)	Queues a dimension type to be registered.
static BootstrapDimensionRegistry	unsafe()	Creates a new UnsafePaperBootstrapDimensionRegistry instance.

Field Details

DATAPACK

@Internal
static final WireProvider<BootstrapDimensionRegistry> DATAPACK

UNSAFE

@Internal
static final WireProvider<BootstrapDimensionRegistry> UNSAFE

Method Details

compose

@AsOf("3.0.0")
static BootstrapDimensionRegistry compose(BootstrapContext context,
 Composer type)

Composes a new datapack-backed BootstrapDimensionRegistry and installs it into the context.

Parameters:

context - the bootstrap context

Returns:

a new, installed BootstrapDimensionRegistry instance

Since:

3.0.0

datapack

@AsOf("3.0.0")
static BootstrapDimensionRegistry datapack()

Creates a new DatapackBootstrapDimensionRegistry instance.

Returns:

a new instance of DatapackBootstrapDimensionRegistry

Since:

3.0.0

unsafe

@AsOf("3.0.0")
static BootstrapDimensionRegistry unsafe()

Creates a new UnsafePaperBootstrapDimensionRegistry instance.

Returns:

a new instance of UnsafePaperBootstrapDimensionRegistry

Since:

3.0.0

install

@AsOf("3.0.0")
BootstrapDimensionRegistry install(BootstrapContext context)

Installs the registry into the given context.

Parameters:

context - the context to install the registry into

Returns:

this registry instance

Since:

3.0.0

queue

@AsOf("3.0.0")
BootstrapDimensionRegistry queue(Dimension dimension)

Queues a dimension type to be registered.

Parameters:

dimension - the dimension type to register

Returns:

this registry instance

Since:

3.0.0

deferring

@AsOf("3.0.0")
BootstrapDimensionRegistry 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:

3.0.0