Interface PoplarTrunkPlacer

All Superinterfaces:

TrunkPlacer, Wrapper

@NullMarked
@AsOf("4.0.0")
public interface PoplarTrunkPlacer
extends TrunkPlacer

Places a poplar trunk with horizontal branches near the top.

Since:

4.0.0

See Also:

• Tree definition (Trunk placer)

Nested Class Summary

Nested Classes

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

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	branchAmount()	The number of horizontal branches, between 1 and 4.
static PoplarTrunkPlacer.Builder	builder()	Creates a new builder.
static PoplarTrunkPlacer	of(int baseHeight, int heightRandA, int heightRandB, IntProvider trunkHeightAboveBranches, IntProvider branchAmount)	Creates a poplar trunk placer.
default PoplarTrunkPlacer.Builder	toBuilder()	Converts this object back to a builder.
IntProvider	trunkHeightAboveBranches()	The number of trunk blocks above the branch layer.

Methods inherited from interface TrunkPlacer

baseHeight, heightRandA, heightRandB

Methods inherited from interface Wrapper

asHandle, toMinecraft, unwrap

Method Details

trunkHeightAboveBranches

@AsOf("4.0.0")
IntProvider trunkHeightAboveBranches()

The number of trunk blocks above the branch layer.

Returns:

the trunk height above branches

Since:

4.0.0

branchAmount

@AsOf("4.0.0")
IntProvider branchAmount()

The number of horizontal branches, between 1 and 4.

Returns:

the branch amount

Since:

4.0.0

toBuilder

@AsOf("4.0.0")
default PoplarTrunkPlacer.Builder toBuilder()

Converts this object back to a builder.

Returns:

a builder containing the same values

Since:

4.0.0

of

@AsOf("4.0.0")
static PoplarTrunkPlacer of(int baseHeight,
 int heightRandA,
 int heightRandB,
 IntProvider trunkHeightAboveBranches,
 IntProvider branchAmount)

Creates a poplar trunk placer.

Parameters:

baseHeight - the base trunk height

heightRandA - the first random height bound

heightRandB - the second random height bound

trunkHeightAboveBranches - the trunk height above branches, between 0 and 8

branchAmount - the number of branches, between 1 and 4

Returns:

a new poplar trunk placer

Since:

4.0.0

builder

@AsOf("4.0.0")
static PoplarTrunkPlacer.Builder builder()

Creates a new builder.

Returns:

a new poplar trunk placer builder

Since:

4.0.0