Interface RandomFeatureConfiguration

All Superinterfaces:

FeatureConfiguration, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface RandomFeatureConfiguration
extends FeatureConfiguration

A configuration for a random feature.

Since:

3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RandomFeatureConfiguration.Builder	Builder for RandomFeatureConfiguration.
static final record	RandomFeatureConfiguration.WeightedPlacedFeature	A weighted placed feature, which consists of a placed feature and a chance of being placed.

Field Summary

Fields inherited from interface FeatureConfiguration

NONE

Method Summary

Modifier and Type	Method	Description
static RandomFeatureConfiguration.Builder	builder()	Creates a new builder.
PlacedFeature	defaultFeature()	Gets the default placed feature.
List<RandomFeatureConfiguration.WeightedPlacedFeature>	features()	Gets the list of weighted placed features.
static RandomFeatureConfiguration	of(List<RandomFeatureConfiguration.WeightedPlacedFeature> features, PlacedFeature defaultFeature)	Creates a new random feature configuration.
default RandomFeatureConfiguration.Builder	toBuilder()	Converts this configuration to a builder.
static RandomFeatureConfiguration.WeightedPlacedFeature	weighted(PlacedFeature feature, float chance)	Creates a new weighted placed feature.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

features

@AsOf("3.0.0")
List<RandomFeatureConfiguration.WeightedPlacedFeature> features()

Gets the list of weighted placed features.

Returns:

the list of weighted placed features

Since:

3.0.0

defaultFeature

@AsOf("3.0.0")
PlacedFeature defaultFeature()

Gets the default placed feature.

Returns:

the default placed feature

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default RandomFeatureConfiguration.Builder toBuilder()

Converts this configuration to a builder.

Returns:

a new builder with the same values as this configuration

Since:

3.0.0

of

@AsOf("3.0.0")
static RandomFeatureConfiguration of(List<RandomFeatureConfiguration.WeightedPlacedFeature> features,
 PlacedFeature defaultFeature)

Creates a new random feature configuration.

Parameters:

features - the list of weighted placed features

defaultFeature - the default placed feature

Returns:

a new random feature configuration

Since:

3.0.0

weighted

@AsOf("3.0.0")
static RandomFeatureConfiguration.WeightedPlacedFeature weighted(PlacedFeature feature,
 float chance)

Creates a new weighted placed feature.

Parameters:

feature - the placed feature

chance - the chance of the feature being placed (between 0.0 and 1.0)

Returns:

a new weighted placed feature

Since:

3.0.0

builder

@AsOf("3.0.0")
static RandomFeatureConfiguration.Builder builder()

Creates a new builder.

Returns:

a new builder

Since:

3.0.0