Interface FloatProvider

All Superinterfaces:

Wrapper

All Known Implementing Classes:

FloatProvider.ClampedNormal, FloatProvider.Constant, FloatProvider.Trapezoid, FloatProvider.Uniform

@NullMarked
@AsOf("2.3.0")
public sealed interface FloatProvider
extends Wrapper
permits FloatProvider.Constant, FloatProvider.Uniform, FloatProvider.ClampedNormal, FloatProvider.Trapezoid

Wraps the FloatProvider value-provider family. Sampling occurs Minecraft code side, so this wrapper only carries the bounds/shape parameters.

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	FloatProvider.ClampedNormal
static final record	FloatProvider.Constant
static interface	FloatProvider.Factory
static final record	FloatProvider.Trapezoid
static final record	FloatProvider.Uniform

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static FloatProvider	clampedNormal(float mean, float deviation, float min, float max)
static FloatProvider	constant(float value)
float	maxValue()
float	minValue()
default Object	toMinecraft()	Convert this handle to the real Minecraft object.
static FloatProvider	trapezoid(float min, float max, float plateau)
static FloatProvider	uniform(float minInclusive, float maxExclusive)

Methods inherited from interface Wrapper

asHandle

Field Details

WIRE

@Internal
static final WireProvider<FloatProvider.Factory> WIRE

Method Details

constant

@AsOf("2.3.0")
static FloatProvider constant(float value)

uniform

@AsOf("2.3.0")
static FloatProvider uniform(float minInclusive,
 float maxExclusive)

clampedNormal

@AsOf("2.3.0")
static FloatProvider clampedNormal(float mean,
 float deviation,
 float min,
 float max)

trapezoid

@AsOf("2.3.0")
static FloatProvider trapezoid(float min,
 float max,
 float plateau)

minValue

@AsOf("2.3.0")
float minValue()

Returns:

the smallest value this provider can yield.

Since:

2.3.0

maxValue

@AsOf("2.3.0")
float maxValue()

Returns:

the largest value this provider can yield.

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