Record Class FallenTreeFeature

java.lang.Object

java.lang.Record

net.minecraft.world.level.levelgen.feature.FallenTreeFeature

All Implemented Interfaces:

Feature

public record FallenTreeFeature(Holder<BlockStateProvider> trunkProvider, IntProvider logLength, List<TreeDecorator> stumpDecorators, List<TreeDecorator> logDecorators)
extends Record
implements Feature

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FallenTreeFeature.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<FallenTreeFeature>	CODEC
private static final int	FALLEN_LOG_MAX_FALL_HEIGHT_TO_GROUND
private static final int	FALLEN_LOG_MAX_GROUND_GAP
private static final int	FALLEN_LOG_MAX_SPACE_FROM_STUMP
private final List<TreeDecorator>	logDecorators	The field for the logDecorators record component.
private final IntProvider	logLength	The field for the logLength record component.
private static final int	STUMP_HEIGHT
private static final int	STUMP_HEIGHT_PLUS_EMPTY_SPACE
private final List<TreeDecorator>	stumpDecorators	The field for the stumpDecorators record component.
private final Holder<BlockStateProvider>	trunkProvider	The field for the trunkProvider record component.

Fields inherited from interface Feature

DIRECT_CODEC, LIST_CODEC

Constructor Summary

Constructors

Constructor	Description
FallenTreeFeature(Holder<BlockStateProvider> trunkProvider, IntProvider logLength, List<TreeDecorator> stumpDecorators, List<TreeDecorator> logDecorators)	Creates an instance of a FallenTreeFeature record class.

Method Summary

Modifier and Type	Method	Description
static FallenTreeFeature.Builder	builder(BlockStateProvider trunkProvider, IntProvider logLength)
private boolean	canPlaceEntireFallenLog(WorldGenLevel level, int logLength, BlockPos.MutableBlockPos logStartPos, Direction direction)
com.mojang.serialization.MapCodec<FallenTreeFeature>	codec()
private void	decorateLogs(WorldGenLevel level, RandomSource random, Set<BlockPos> logs, List<TreeDecorator> decorators)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
private BiConsumer<BlockPos, BlockState>	getDecorationSetter(WorldGenLevel level)
private static Function<BlockState, BlockState>	getSidewaysStateModifier(Direction direction)
final int	hashCode()	Returns a hash code value for this object.
private boolean	isOverSolidGround(LevelAccessor level, BlockPos blockPos)
List<TreeDecorator>	logDecorators()	Returns the value of the logDecorators record component.
IntProvider	logLength()	Returns the value of the logLength record component.
private boolean	mayPlaceOn(LevelAccessor level, BlockPos blockPos)
boolean	place(WorldGenLevel level, ChunkGenerator chunkGenerator, RandomSource random, BlockPos origin)
private void	placeFallenLog(WorldGenLevel level, RandomSource random, int logLength, BlockPos.MutableBlockPos logStartPos, Direction direction)
private void	placeFallenTree(BlockPos origin, WorldGenLevel level, RandomSource random)
private BlockPos	placeLogBlock(WorldGenLevel level, RandomSource random, BlockPos.MutableBlockPos blockPos, Function<BlockState, BlockState> sidewaysStateModifier)
private void	placeStump(WorldGenLevel level, RandomSource random, BlockPos.MutableBlockPos stumpPos)
private void	setGroundHeightForFallenLogStartPos(WorldGenLevel level, BlockPos.MutableBlockPos logStartPos)
List<TreeDecorator>	stumpDecorators()	Returns the value of the stumpDecorators record component.
final String	toString()	Returns a string representation of this record class.
Holder<BlockStateProvider>	trunkProvider()	Returns the value of the trunkProvider record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Feature

getSubFeatures, markAboveForPostProcessing, safeSetBlock, setBlock

Field Details

trunkProvider

private final Holder<BlockStateProvider> trunkProvider

The field for the trunkProvider record component.

logLength

private final IntProvider logLength

The field for the logLength record component.

stumpDecorators

private final List<TreeDecorator> stumpDecorators

The field for the stumpDecorators record component.

logDecorators

private final List<TreeDecorator> logDecorators

The field for the logDecorators record component.

STUMP_HEIGHT

private static final int STUMP_HEIGHT

See Also:

• Constant Field Values

STUMP_HEIGHT_PLUS_EMPTY_SPACE

private static final int STUMP_HEIGHT_PLUS_EMPTY_SPACE

See Also:

• Constant Field Values

FALLEN_LOG_MAX_FALL_HEIGHT_TO_GROUND

private static final int FALLEN_LOG_MAX_FALL_HEIGHT_TO_GROUND

See Also:

• Constant Field Values

FALLEN_LOG_MAX_GROUND_GAP

private static final int FALLEN_LOG_MAX_GROUND_GAP

See Also:

• Constant Field Values

FALLEN_LOG_MAX_SPACE_FROM_STUMP

private static final int FALLEN_LOG_MAX_SPACE_FROM_STUMP

See Also:

• Constant Field Values

CODEC

public static final com.mojang.serialization.MapCodec<FallenTreeFeature> CODEC

Constructor Details

FallenTreeFeature

public FallenTreeFeature(Holder<BlockStateProvider> trunkProvider,
 IntProvider logLength,
 List<TreeDecorator> stumpDecorators,
 List<TreeDecorator> logDecorators)

Creates an instance of a FallenTreeFeature record class.

Parameters:

trunkProvider - the value for the trunkProvider record component

logLength - the value for the logLength record component

stumpDecorators - the value for the stumpDecorators record component

logDecorators - the value for the logDecorators record component

Method Details

codec

public com.mojang.serialization.MapCodec<FallenTreeFeature> codec()

Specified by:

codec in interface Feature

place

public boolean place(WorldGenLevel level,
 ChunkGenerator chunkGenerator,
 RandomSource random,
 BlockPos origin)

Specified by:

place in interface Feature

placeFallenTree

private void placeFallenTree(BlockPos origin,
 WorldGenLevel level,
 RandomSource random)

setGroundHeightForFallenLogStartPos

private void setGroundHeightForFallenLogStartPos(WorldGenLevel level,
 BlockPos.MutableBlockPos logStartPos)

placeStump

private void placeStump(WorldGenLevel level,
 RandomSource random,
 BlockPos.MutableBlockPos stumpPos)

canPlaceEntireFallenLog

private boolean canPlaceEntireFallenLog(WorldGenLevel level,
 int logLength,
 BlockPos.MutableBlockPos logStartPos,
 Direction direction)

placeFallenLog

private void placeFallenLog(WorldGenLevel level,
 RandomSource random,
 int logLength,
 BlockPos.MutableBlockPos logStartPos,
 Direction direction)

mayPlaceOn

private boolean mayPlaceOn(LevelAccessor level,
 BlockPos blockPos)

isOverSolidGround

private boolean isOverSolidGround(LevelAccessor level,
 BlockPos blockPos)

placeLogBlock

private BlockPos placeLogBlock(WorldGenLevel level,
 RandomSource random,
 BlockPos.MutableBlockPos blockPos,
 Function<BlockState, BlockState> sidewaysStateModifier)

decorateLogs

private void decorateLogs(WorldGenLevel level,
 RandomSource random,
 Set<BlockPos> logs,
 List<TreeDecorator> decorators)

getDecorationSetter

private BiConsumer<BlockPos, BlockState> getDecorationSetter(WorldGenLevel level)

getSidewaysStateModifier

private static Function<BlockState, BlockState> getSidewaysStateModifier(Direction direction)

builder

public static FallenTreeFeature.Builder builder(BlockStateProvider trunkProvider,
 IntProvider logLength)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

trunkProvider

public Holder<BlockStateProvider> trunkProvider()

Returns the value of the trunkProvider record component.

Returns:

the value of the trunkProvider record component

logLength

public IntProvider logLength()

Returns the value of the logLength record component.

Returns:

the value of the logLength record component

stumpDecorators

public List<TreeDecorator> stumpDecorators()

Returns the value of the stumpDecorators record component.

Returns:

the value of the stumpDecorators record component

logDecorators

public List<TreeDecorator> logDecorators()

Returns the value of the logDecorators record component.

Returns:

the value of the logDecorators record component