Interface UpwardsBranchingTrunkPlacer

All Superinterfaces:

TrunkPlacer, Wrapper

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

Places a straight trunk with branches extending up and outwards from the trunk.

Since:

3.0.0

See Also:

• Tree definition (Trunk placer)

Nested Class Summary

Nested Classes

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

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
static UpwardsBranchingTrunkPlacer.Builder	builder()	Creates a new builder.
Set<Material>	canGrowThrough()	Represents blocks that tree trunks can grow through.
IntProvider	extraBranchLength()	Generates extra branch length.
IntProvider	extraBranchSteps()	The number of steps to generate extra branches.
static UpwardsBranchingTrunkPlacer	of(int baseHeight, int heightRandA, int heightRandB, IntProvider extraBranchSteps, float placeBranchPerLogProbability, IntProvider extraBranchLength, Set<Material> canGrowThrough)	Creates a new upwards branching trunk placer.
float	placeBranchPerLogProbability()	The probability of each log producing a branch between 0.0 and 1.0.
default UpwardsBranchingTrunkPlacer.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

extraBranchSteps

@AsOf("3.0.0")
IntProvider extraBranchSteps()

The number of steps to generate extra branches. Must be positive.

Returns:

the number of steps to generate extra branches

Since:

3.0.0

placeBranchPerLogProbability

@AsOf("3.0.0")
float placeBranchPerLogProbability()

The probability of each log producing a branch between 0.0 and 1.0.

Returns:

the probability of each log producing a branch

Since:

3.0.0

extraBranchLength

@AsOf("3.0.0")
IntProvider extraBranchLength()

Generates extra branch length. Must be positive.

Returns:

the extra branch length

Since:

3.0.0

canGrowThrough

@AsOf("3.0.0")
Set<Material> canGrowThrough()

Represents blocks that tree trunks can grow through.

Returns:

the blocks that tree trunks can grow through

Since:

3.0.0

toBuilder

@AsOf("3.0.0")
default UpwardsBranchingTrunkPlacer.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 UpwardsBranchingTrunkPlacer of(int baseHeight,
 int heightRandA,
 int heightRandB,
 IntProvider extraBranchSteps,
 float placeBranchPerLogProbability,
 IntProvider extraBranchLength,
 Set<Material> canGrowThrough)

Creates a new upwards branching trunk placer.

Parameters:

baseHeight - the base height of the trunk

heightRandA - the random height modifier

heightRandB - the random height modifier

extraBranchSteps - the number of steps to generate extra branches

placeBranchPerLogProbability - the probability of each log producing a branch

extraBranchLength - the extra branch length

canGrowThrough - the blocks that tree trunks can grow through

Returns:

a new upwards branching trunk placer

Since:

3.0.0

builder

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

Creates a new builder.

Returns:

a new builder

Since:

3.0.0