Interface HeightProvider

All Superinterfaces:

Wrapper

All Known Implementing Classes:

HeightProvider.BiasedToBottom, HeightProvider.Constant, HeightProvider.Trapezoid, HeightProvider.Uniform, HeightProvider.VeryBiasedToBottom

@NullMarked
@AsOf("2.3.0")
public sealed interface HeightProvider
extends Wrapper
permits HeightProvider.Constant, HeightProvider.Uniform, HeightProvider.Trapezoid, HeightProvider.BiasedToBottom, HeightProvider.VeryBiasedToBottom

Wraps the HeightProvider value-provider family.

Since:

2.3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	HeightProvider.BiasedToBottom
static final record	HeightProvider.Constant
static interface	HeightProvider.Factory
static final record	HeightProvider.Trapezoid
static final record	HeightProvider.Uniform
static final record	HeightProvider.VeryBiasedToBottom

Nested classes/interfaces inherited from interface Wrapper

Wrapper.Context<C>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static HeightProvider	biasedToBottom(VerticalAnchor minInclusive, VerticalAnchor maxInclusive, int inner)	Weighted toward the bottom of the range.
static HeightProvider	constant(VerticalAnchor value)	A single fixed anchor.
default Object	toMinecraft()	Convert this handle to the real Minecraft object.
static HeightProvider	trapezoid(VerticalAnchor minInclusive, VerticalAnchor maxInclusive, int plateau)	Trapezoidal distribution with a flat plateau of the given height.
static HeightProvider	uniform(VerticalAnchor minInclusive, VerticalAnchor maxInclusive)	Uniformly distributed between two anchors (inclusive).
static HeightProvider	veryBiasedToBottom(VerticalAnchor minInclusive, VerticalAnchor maxInclusive, int inner)	Weighted very strongly toward the bottom of the range.

Methods inherited from interface Wrapper

asHandle

Field Details

WIRE

@Internal
static final WireProvider<HeightProvider.Factory> WIRE

Method Details

constant

@AsOf("2.3.0")
static HeightProvider constant(VerticalAnchor value)

A single fixed anchor.

uniform

@AsOf("2.3.0")
static HeightProvider uniform(VerticalAnchor minInclusive,
 VerticalAnchor maxInclusive)

Uniformly distributed between two anchors (inclusive).

trapezoid

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

Trapezoidal distribution with a flat plateau of the given height.

biasedToBottom

@AsOf("2.3.0")
static HeightProvider biasedToBottom(VerticalAnchor minInclusive,
 VerticalAnchor maxInclusive,
 int inner)

Weighted toward the bottom of the range.

veryBiasedToBottom

@AsOf("2.3.0")
static HeightProvider veryBiasedToBottom(VerticalAnchor minInclusive,
 VerticalAnchor maxInclusive,
 int inner)

Weighted very strongly toward the bottom of the range.

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