Interface FeatureConfiguration

All Superinterfaces:

Wrapper

All Known Subinterfaces:

CarverConfiguration

All Known Implementing Classes:

CanyonCarverConfiguration, CaveCarverConfiguration, FeatureConfiguration.ColumnConfiguration, FeatureConfiguration.CountConfiguration, FeatureConfiguration.DripstoneClusterConfiguration, FeatureConfiguration.LargeDripstoneConfiguration, FeatureConfiguration.NoneConfiguration, FeatureConfiguration.PointedDripstoneConfiguration, FeatureConfiguration.ProbabilityConfiguration, FeatureConfiguration.SculkPatchConfiguration

@NullMarked
@AsOf("2.3.0")
public interface FeatureConfiguration
extends Wrapper

Wraps Minecraft's FeatureConfiguration.

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	FeatureConfiguration.ColumnConfiguration	A column feature.
static final record	FeatureConfiguration.CountConfiguration	A number of placement attempts.
static final record	FeatureConfiguration.DripstoneClusterConfiguration	A dripstone cluster.
static interface	FeatureConfiguration.Factory
static final record	FeatureConfiguration.LargeDripstoneConfiguration	A large dripstone.
static final record	FeatureConfiguration.NoneConfiguration	The empty configuration used by feature types that take no parameters.
static final record	FeatureConfiguration.PointedDripstoneConfiguration	Pointed dripstone spread chances.
static final record	FeatureConfiguration.ProbabilityConfiguration	A single placement probability, in the range [0, 1].
static final record	FeatureConfiguration.SculkPatchConfiguration	A sculk patch.

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static FeatureConfiguration.ColumnConfiguration	column(IntProvider reach, IntProvider height)	A column feature, with reach constrained to [0, 3] and height to [1, 10].
static FeatureConfiguration.CountConfiguration	count(IntProvider count)	A number of placement attempts, constrained by the vanilla codec to [0, 256].
static FeatureConfiguration.DripstoneClusterConfiguration.Builder	dripstoneCluster()	A builder for a dripstone cluster.
static FeatureConfiguration.LargeDripstoneConfiguration.Builder	largeDripstone()	A builder for a large dripstone.
static FeatureConfiguration.NoneConfiguration	none()	The empty configuration for feature types that take no parameters.
static FeatureConfiguration.PointedDripstoneConfiguration.Builder	pointedDripstone()	A builder for pointed dripstone spread chances.
static FeatureConfiguration.ProbabilityConfiguration	probability(float probability)	A single placement probability, in the range [0, 1].
static FeatureConfiguration.SculkPatchConfiguration.Builder	sculkPatch()	A builder for a sculk patch.
default Object	toMinecraft()	Convert this handle to the real Minecraft object.

Methods inherited from interface Wrapper

asHandle

Field Details

WIRE

@Internal
static final WireProvider<FeatureConfiguration.Factory> WIRE

Method Details

toMinecraft

@AsOf("3.0.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

none

@AsOf("3.0.0")
static FeatureConfiguration.NoneConfiguration none()

The empty configuration for feature types that take no parameters.

Returns:

the none configuration

Since:

3.0.0

probability

@AsOf("3.0.0")
static FeatureConfiguration.ProbabilityConfiguration probability(float probability)

A single placement probability, in the range [0, 1].

Parameters:

probability - the placement probability

Returns:

the configuration

Since:

3.0.0

pointedDripstone

@AsOf("3.0.0")
static FeatureConfiguration.PointedDripstoneConfiguration.Builder pointedDripstone()

A builder for pointed dripstone spread chances.

Returns:

a new builder

Since:

3.0.0

count

@AsOf("3.0.0")
static FeatureConfiguration.CountConfiguration count(IntProvider count)

A number of placement attempts, constrained by the vanilla codec to [0, 256].

Parameters:

count - the count provider

Returns:

the configuration

Since:

3.0.0

column

@AsOf("3.0.0")
static FeatureConfiguration.ColumnConfiguration column(IntProvider reach,
 IntProvider height)

A column feature, with reach constrained to [0, 3] and height to [1, 10].

Parameters:

reach - the horizontal reach provider

height - the column height provider

Returns:

the configuration

Since:

3.0.0

sculkPatch

@AsOf("3.0.0")
static FeatureConfiguration.SculkPatchConfiguration.Builder sculkPatch()

A builder for a sculk patch.

Returns:

a new builder

Since:

3.0.0

dripstoneCluster

@AsOf("3.0.0")
static FeatureConfiguration.DripstoneClusterConfiguration.Builder dripstoneCluster()

A builder for a dripstone cluster.

Returns:

a new builder

Since:

3.0.0

largeDripstone

@AsOf("3.0.0")
static FeatureConfiguration.LargeDripstoneConfiguration.Builder largeDripstone()

A builder for a large dripstone.

Returns:

a new builder

Since:

3.0.0