Interface IntProvider

All Superinterfaces:

Wrapper

All Known Implementing Classes:

IntProvider.BiasedToBottom, IntProvider.Clamped, IntProvider.ClampedNormal, IntProvider.Constant, IntProvider.Trapezoid, IntProvider.Uniform, IntProvider.WeightedListInt

@NullMarked
@AsOf("2.3.0")
public sealed interface IntProvider
extends Wrapper
permits IntProvider.Constant, IntProvider.Uniform, IntProvider.BiasedToBottom, IntProvider.ClampedNormal, IntProvider.Trapezoid, IntProvider.Clamped, IntProvider.WeightedListInt

Wraps the IntProvider value-provider family. Sampling occurs NMS-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	IntProvider.BiasedToBottom
static final record	IntProvider.Clamped
static final record	IntProvider.ClampedNormal
static final record	IntProvider.Constant
static interface	IntProvider.Factory
static final record	IntProvider.Trapezoid
static final record	IntProvider.Uniform
static final record	IntProvider.WeightedListInt

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static IntProvider	biasedToBottom(int minInclusive, int maxInclusive)
static IntProvider	clamped(IntProvider source, int minInclusive, int maxInclusive)
static IntProvider	clampedNormal(float mean, float deviation, int minInclusive, int maxInclusive)
static IntProvider	constant(int value)
int	maxInclusive()	The largest value this provider can yield.
int	minInclusive()	The smallest value this provider can yield.
default Object	toMinecraft()	Convert this handle to the real Minecraft object.
static IntProvider	trapezoid(int minInclusive, int maxInclusive, int plateau)
static IntProvider	triangle(int range)	A symmetric triangular distribution over [-range, range], matching TrapezoidInt.triangle.
static IntProvider	uniform(int minInclusive, int maxInclusive)
static IntProvider	weightedList(WeightedList<IntProvider> distribution)

Methods inherited from interface Wrapper

asHandle

Field Details

WIRE

@Internal
static final WireProvider<IntProvider.Factory> WIRE

Method Details

constant

@AsOf("2.3.0")
static IntProvider constant(int value)

uniform

@AsOf("2.3.0")
static IntProvider uniform(int minInclusive,
 int maxInclusive)

biasedToBottom

@AsOf("2.3.0")
static IntProvider biasedToBottom(int minInclusive,
 int maxInclusive)

clampedNormal

@AsOf("2.3.0")
static IntProvider clampedNormal(float mean,
 float deviation,
 int minInclusive,
 int maxInclusive)

trapezoid

@AsOf("2.3.0")
static IntProvider trapezoid(int minInclusive,
 int maxInclusive,
 int plateau)

triangle

@AsOf("2.3.0")
static IntProvider triangle(int range)

A symmetric triangular distribution over [-range, range], matching TrapezoidInt.triangle.

clamped

@AsOf("2.3.0")
static IntProvider clamped(IntProvider source,
 int minInclusive,
 int maxInclusive)

weightedList

@AsOf("2.3.0")
static IntProvider weightedList(WeightedList<IntProvider> distribution)

minInclusive

@AsOf("2.3.0")
int minInclusive()

The smallest value this provider can yield.

Returns:

the smallest value this provider can yield.

Since:

2.3.0

maxInclusive

@AsOf("2.3.0")
int maxInclusive()

The largest value this provider can yield.

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