Interface AboveRootPlacement

All Superinterfaces:

Wrapper

@NullMarked
@AsOf("3.0.0")
public interface AboveRootPlacement
extends Wrapper

The blocks placed above the root of a tree.

Since:

3.0.0

See Also:

• Tree definition (Root placer)

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
float	aboveRootPlacementChance()	The probability of generating the block, between 0.0F and 1.0F (inclusive).
BlockStateProvider	aboveRootProvider()	The block above the root.
static AboveRootPlacement.Builder	builder()	Creates a new builder.
static AboveRootPlacement	of(BlockStateProvider aboveRootProvider, float aboveRootPlacementChance)	Creates a new above root placement.
default AboveRootPlacement.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

aboveRootProvider

@AsOf("3.0.0")
BlockStateProvider aboveRootProvider()

The block above the root.

Returns:

the above root block state provider

Since:

3.0.0

aboveRootPlacementChance

@AsOf("3.0.0")
float aboveRootPlacementChance()

The probability of generating the block, between 0.0F and 1.0F (inclusive).

Returns:

the above root placement chance

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default AboveRootPlacement.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 AboveRootPlacement of(BlockStateProvider aboveRootProvider,
 float aboveRootPlacementChance)

Creates a new above root placement.

Parameters:

aboveRootProvider - the block above the root

aboveRootPlacementChance - the probability of generating the block, between 0.0F and 1.0F (inclusive)

Returns:

a new above root placement

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0