Interface ConfiguredFeature

All Superinterfaces:

Keyed, Wrapper

All Known Subinterfaces:

AbstractCustomFeature

All Known Implementing Classes:

ConfiguredFeature.CustomConfigured, ConfiguredFeature.Reference, ConfiguredFeature.VanillaConfigured, CustomFeature

@NullMarked
@AsOf("2.3.0")
public sealed interface ConfiguredFeature
extends Wrapper, Keyed
permits ConfiguredFeature.CustomConfigured, ConfiguredFeature.Reference, ConfiguredFeature.VanillaConfigured, AbstractCustomFeature

Wraps Minecraft's ConfiguredFeature.

• ConfiguredFeature.Reference is a reference to an already-registered configured feature.
• ConfiguredFeature.VanillaConfigured is a configured feature authored from a vanilla feature type and configuration.
• ConfiguredFeature.CustomConfigured is a configured feature composed of a registered custom feature with a config instance. The feature must already be registered under featureKey via CustomFeature.registerAs(ResourceKey).

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ConfiguredFeature.CustomConfigured	A configured feature composed of a registered custom feature with a config instance.
static interface	ConfiguredFeature.Factory
static final record	ConfiguredFeature.Reference	A reference to an already-registered configured feature.
static final record	ConfiguredFeature.VanillaConfigured	A configured feature authored from a vanilla feature type and configuration.

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

Modifier and Type	Field	Description
static final WireProvider<ConfiguredFeature.Factory>	WIRE

Method Summary

Modifier and Type	Method	Description
static ConfiguredFeature.CustomConfigured	custom(ResourceKey featureKey, Object config)	Composes a registered custom feature with a config instance.
static ConfiguredFeature	reference(ResourceKey key)	References a configured feature already registered under the given key.
default Object	toMinecraft()	Convert this handle to the real Minecraft object.
static ConfiguredFeature.VanillaConfigured	vanilla(FeatureType featureType, FeatureConfiguration configuration)	Authors a configured feature from a vanilla feature type and configuration.

Methods inherited from interface Keyed

key

Methods inherited from interface Wrapper

asHandle

Field Details

WIRE

@Internal
static final WireProvider<ConfiguredFeature.Factory> WIRE

Method Details

reference

@AsOf("2.3.0")
static ConfiguredFeature reference(ResourceKey key)

References a configured feature already registered under the given key.

Parameters:

key - the registry key of the configured feature

Returns:

a reference to the registered configured feature

Since:

2.3.0

vanilla

@AsOf("2.3.0")
static ConfiguredFeature.VanillaConfigured vanilla(FeatureType featureType,
 FeatureConfiguration configuration)

Authors a configured feature from a vanilla feature type and configuration.

Parameters:

featureType - the vanilla feature algorithm

configuration - the vanilla configuration for it

Returns:

an authored configured feature

Since:

2.3.0

custom

@AsOf("2.3.0")
static ConfiguredFeature.CustomConfigured custom(ResourceKey featureKey,
 Object config)

Composes a registered custom feature with a config instance. The feature must already be registered under featureKey via CustomFeature.register(...). The same feature may be composed with different configs.

Parameters:

featureKey - the key the custom feature was registered under

config - the config instance to place with

Returns:

an authored configured feature

Since:

2.3.0

toMinecraft

@AsOf("2.3.0")
default Object toMinecraft()

Description copied from interface: Wrapper

Convert this handle to the real Minecraft object.

Specified by:

toMinecraft in interface Wrapper

Returns:

the real Minecraft object