Interface CherryTrunkPlacer

All Superinterfaces:

TrunkPlacer, Wrapper

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

Places a U shape trunk of multiple branches.

Since:

3.0.0

See Also:

• Tree definition (Trunk placer)

Nested Class Summary

Nested Classes

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

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	branchCount()	The number of branches between 1 and 3.
IntProvider	branchEndOffsetFromTop()	The offset of the branches from the top between -16 and 16.
IntProvider	branchHorizontalLength()	The horizontal length of the branches between 2 and 16.
UniformInt	branchStartOffsetFromTop()	The offset of the branches from the top between -16 and 16.
static CherryTrunkPlacer.Builder	builder()	Creates a new builder.
static CherryTrunkPlacer	of(int baseHeight, int heightRandA, int heightRandB, IntProvider branchCount, IntProvider branchHorizontalLength, IntProvider branchStartOffsetFromTop, IntProvider branchEndOffsetFromTop)	Creates a new cherry trunk placer.
default CherryTrunkPlacer.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

branchCount

@AsOf("3.0.0")
IntProvider branchCount()

The number of branches between 1 and 3.

Returns:

the number of branches

Since:

3.0.0

branchHorizontalLength

@AsOf("3.0.0")
IntProvider branchHorizontalLength()

The horizontal length of the branches between 2 and 16.

Returns:

the horizontal length of the branches

Since:

3.0.0

branchStartOffsetFromTop

@AsOf("3.0.0")
UniformInt branchStartOffsetFromTop()

The offset of the branches from the top between -16 and 16.

Returns:

the offset of the branches

Since:

3.0.0

branchEndOffsetFromTop

@AsOf("3.0.0")
IntProvider branchEndOffsetFromTop()

The offset of the branches from the top between -16 and 16.

Returns:

the offset of the branches

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default CherryTrunkPlacer.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 CherryTrunkPlacer of(int baseHeight,
 int heightRandA,
 int heightRandB,
 IntProvider branchCount,
 IntProvider branchHorizontalLength,
 IntProvider branchStartOffsetFromTop,
 IntProvider branchEndOffsetFromTop)

Creates a new cherry trunk placer.

Parameters:

baseHeight - the base height of the trunk

heightRandA - the random height modifier

heightRandB - the random height modifier

branchCount - the number of branches

branchHorizontalLength - the horizontal length of the branches

branchStartOffsetFromTop - the offset of the branches from the top

branchEndOffsetFromTop - the offset of the branches from the top

Returns:

a new cherry trunk placer

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0