Interface BendingTrunkPlacer

All Superinterfaces:

TrunkPlacer, Wrapper

@NullMarked
@AsOf("3.0.0")
public interface BendingTrunkPlacer
extends TrunkPlacer

Places a trunk of the specified height. The topmost 2 blocks have a chance to be moved by one block each. On top of the trunk a straight branch of length bendLength() is generated. Foliage is attached to all block of the top branch and any trunk block that is higher than minHeightForLeaves().

Since:

3.0.0

See Also:

• Tree definition (Trunk placer)

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface TrunkPlacer

TrunkPlacer.TrunkPlacerBuilder<T,P>

Field Summary

Fields inherited from interface TrunkPlacer

MAX_BASE_HEIGHT, MAX_RAND

Method Summary

Modifier and Type	Method	Description
IntProvider	bendLength()	The length of the bend between 1 and 64.
static BendingTrunkPlacer.Builder	builder()	Creates a new builder.
int	minHeightForLeaves()	The minimum height for leaves.
static BendingTrunkPlacer	of(int minHeight, int maxHeight, int bendLength, int minHeightForLeaves, IntProvider bendLengthProvider)	Creates a new bending trunk placer.
default BendingTrunkPlacer.Builder	toBuilder()	Converts this object back to a builder.

Methods inherited from interface TrunkPlacer

baseHeight, heightRandA, heightRandB

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

minHeightForLeaves

@AsOf("3.0.0")
int minHeightForLeaves()

The minimum height for leaves. Must be a positive integer.

Returns:

the minimum height for leaves

Since:

3.0.0

bendLength

@AsOf("3.0.0")
IntProvider bendLength()

The length of the bend between 1 and 64.

Returns:

the bend length

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default BendingTrunkPlacer.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 BendingTrunkPlacer of(int minHeight,
 int maxHeight,
 int bendLength,
 int minHeightForLeaves,
 IntProvider bendLengthProvider)

Creates a new bending trunk placer.

Parameters:

minHeight - the minimum height of the trunk

maxHeight - the maximum height of the trunk

bendLength - the length of the bend between 1 and 64

minHeightForLeaves - the minimum height for leaves

bendLengthProvider - the length of the bend between 1 and 64

Returns:

a new bending trunk placer

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0