Interface BiasedToBottomHeight

All Superinterfaces:

HeightProvider, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface BiasedToBottomHeight
extends HeightProvider

A height provider biased toward HeightProvider.minInclusive(). Values at or below inner() follow a uniform distribution and above it an exponential one.

Since:

3.0.0

See Also:

• Height provider

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface HeightProvider

HeightProvider.HeightProviderBuilder<T,S>

Method Summary

Modifier and Type	Method	Description
static BiasedToBottomHeight.Builder	builder()	Creates a new builder.
int	inner()	The bias factor.
static BiasedToBottomHeight	of(VerticalAnchor minInclusive, VerticalAnchor maxInclusive, int inner)	Creates a new biased-to-bottom height provider.
default BiasedToBottomHeight.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface HeightProvider

maxInclusive, minInclusive

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

inner

@AsOf("3.0.0")
int inner()

The bias factor. Values between 1 and max - min (inclusive) are uniformly distributed and values above it follow an exponential distribution.

Returns:

the bias factor

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default BiasedToBottomHeight.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 BiasedToBottomHeight of(VerticalAnchor minInclusive,
 VerticalAnchor maxInclusive,
 int inner)

Creates a new biased-to-bottom height provider.

Parameters:

minInclusive - the vertical anchor to use as the minimum height

maxInclusive - the vertical anchor to use as the maximum height

inner - the bias factor

Returns:

the biased-to-bottom height provider

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0