Interface CustomComposedConfiguredFeature<C>

Type Parameters:

C - the configuration type carried to the custom feature

All Superinterfaces:

ConfiguredFeature, Keyed, Registerable<CustomComposedConfiguredFeature<C>>, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface CustomComposedConfiguredFeature<C>
extends ConfiguredFeature, Registerable<CustomComposedConfiguredFeature<C>>

A configured feature composed of a user-authored CustomFeature and a matching configuration instance.

Since:

3.0.0

See Also:

• Configured feature

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CustomComposedConfiguredFeature.Builder<C>	Builder for CustomComposedConfiguredFeature.

Method Summary

Modifier and Type	Method	Description
static <C> CustomComposedConfiguredFeature.Builder<C>	builder()	Creates a new builder.
C	config()	The configuration instance carried to the custom feature.
CustomFeature<C>	feature()	The custom feature this configured feature composes.
static <C> CustomComposedConfiguredFeature<C>	of(@Nullable ResourceKey resourceKey, CustomFeature<C> feature, C config)	Creates a new custom composed configured feature.
static <C> CustomComposedConfiguredFeature<C>	of(CustomFeature<C> feature, C config)	Creates a new custom composed configured feature without a resource key.
default CustomComposedConfiguredFeature.Builder<C>	toBuilder()	Converts this composed configured feature to a builder.

Methods inherited from interface ConfiguredFeature

resourceKey, wrap

Methods inherited from interface Keyed

key

Methods inherited from interface Registerable

register

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

feature

@AsOf("3.0.0")
CustomFeature<C> feature()

The custom feature this configured feature composes.

Returns:

the custom feature

Since:

3.0.0

config

@AsOf("3.0.0")
C config()

The configuration instance carried to the custom feature.

Returns:

the configuration

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default CustomComposedConfiguredFeature.Builder<C> toBuilder()

Converts this composed configured feature to a builder.

Returns:

a builder with the same values as this composed configured feature

Since:

3.0.0

of

@AsOf("3.0.0")
static <C> CustomComposedConfiguredFeature<C> of(@Nullable ResourceKey resourceKey,
 CustomFeature<C> feature,
 C config)

Creates a new custom composed configured feature.

Type Parameters:

C - the configuration type

Parameters:

resourceKey - the resource key of the configured feature, or null if not present

feature - the custom feature

config - the configuration instance carried to the custom feature

Returns:

a new custom composed configured feature

Since:

3.0.0

of

@AsOf("3.0.0")
static <C> CustomComposedConfiguredFeature<C> of(CustomFeature<C> feature,
 C config)

Creates a new custom composed configured feature without a resource key.

Type Parameters:

C - the configuration type

Parameters:

feature - the custom feature

config - the configuration instance carried to the custom feature

Returns:

a new custom composed configured feature

Since:

3.0.0

builder

@AsOf("3.0.0")
static <C>
CustomComposedConfiguredFeature.Builder<C> builder()

Creates a new builder.

Type Parameters:

C - the configuration type

Returns:

a new builder

Since:

3.0.0