Interface ClampedNormalInt

All Superinterfaces:

Comparable<ValueProvider>, IntProvider, ValueProvider, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface ClampedNormalInt
extends IntProvider

Clamped normal samples a bell curve centered at mean with spread deviation, then forces the result into [IntProvider.minInclusive(), IntProvider.maxInclusive()]. Anything outside gets snapped to the nearest bound rather than rerolled.

Since:

3.0.0

See Also:

• Bell-shaped function
• int provider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ClampedNormalInt.Builder	Builder for ClampedNormalInt.

Nested classes/interfaces inherited from interface IntProvider

IntProvider.IntProviderBuilder<T,S>

Method Summary

Modifier and Type	Method	Description
static ClampedNormalInt.Builder	builder()	Creates a new builder.
float	deviation()	The deviation of the normal distribution.
float	mean()	The mean of the normal distribution.
static ClampedNormalInt	of(int min, int max, float mean, float deviation)	Creates a new ClampedNormalInt.
default ClampedNormalInt.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface IntProvider

clamp, max, maxInclusive, min, minInclusive

Methods inherited from interface ValueProvider

compareTo

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

mean

@AsOf("3.0.0")
float mean()

The mean of the normal distribution.

Returns:

the mean of the normal distribution

Since:

3.0.0

deviation

@AsOf("3.0.0")
float deviation()

The deviation of the normal distribution.

Returns:

the deviation of the normal distribution

Since:

3.0.0

toBuilder

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

Converts this object back to a builder.

Returns:

a builder with the same values as this object

Since:

3.0.0

of

@AsOf("3.0.0")
static ClampedNormalInt of(int min,
 int max,
 float mean,
 float deviation)

Creates a new ClampedNormalInt.

Parameters:

min - the minimum value

max - the maximum value

mean - the mean of the normal distribution

deviation - the deviation of the normal distribution

Returns:

the ClampedNormalInt

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0