Interface RootPlacer

All Superinterfaces:

Wrapper

All Known Subinterfaces:

MangroveRootPlacer

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

Controls the placement and shape of the roots for a tree and moving the trunk upwards.

Since:

3.0.0

See Also:

• Tree definition (Root placer)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RootPlacer.RootPlacerBuilder<T,P>	A builder for RootPlacers.

Method Summary

Modifier and Type	Method	Description
Optional<AboveRootPlacement>	aboveRootPlacement()	The blocks above the root, if present.
static RootPlacer	decode(Object minecraftRootPlacer)
static MangroveRootPlacer.Builder	mangrove()	A new builder for a MangroveRootPlacer.
BlockStateProvider	rootProvider()	The block used as the root of the tree.
IntProvider	trunkOffsetY()	The offset perpendicular to the trunk.

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

trunkOffsetY

@AsOf("3.0.0")
IntProvider trunkOffsetY()

The offset perpendicular to the trunk.

Returns:

the trunk offset

Since:

3.0.0

rootProvider

@AsOf("3.0.0")
BlockStateProvider rootProvider()

The block used as the root of the tree.

Returns:

the root block state provider

Since:

3.0.0

aboveRootPlacement

@AsOf("3.0.0")
Optional<AboveRootPlacement> aboveRootPlacement()

The blocks above the root, if present.

Returns:

the above root placement, or empty if not set

Since:

3.0.0

mangrove

@AsOf("3.0.0")
static MangroveRootPlacer.Builder mangrove()

A new builder for a MangroveRootPlacer.

Returns:

a new builder

Since:

3.0.0

decode

@Internal
static RootPlacer decode(Object minecraftRootPlacer)