Package net.minecraftforge.event.level

Class SaplingGrowTreeEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.level.LevelEvent

net.minecraftforge.event.level.SaplingGrowTreeEvent

public class SaplingGrowTreeEvent
extends LevelEvent

This event is fired whenever a sapling, fungus, mushroom or azalea grows into a tree. This event is fired during sapling growth in SaplingBlock.advanceTree(ServerLevel, BlockPos, BlockState, RandomSource).

This event is not cancellable but does have a result. ALLOW and DEFAULT will allow the sapling to grow using the features set on the event. DENY will prevent the sapling from growing.

This event is fired on the main Forge event bus only on the logical server. TODO 1.20 rename event

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.event.level.LevelEvent

LevelEvent.CreateSpawnPosition, LevelEvent.Load, LevelEvent.PotentialSpawns, LevelEvent.Save, LevelEvent.Unload

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private @Nullable Holder<ConfiguredFeature<?,?>>	feature
private final BlockPos	pos
private final RandomSource	randomSource

Constructor Summary

Constructors

Constructor	Description
SaplingGrowTreeEvent(LevelAccessor level, RandomSource randomSource, BlockPos pos)	Deprecated, for removal: This API element is subject to removal in a future version.
SaplingGrowTreeEvent(LevelAccessor level, RandomSource randomSource, BlockPos pos, @Nullable Holder<ConfiguredFeature<?,?>> feature)

Method Summary

Modifier and Type	Method	Description
@Nullable Holder<ConfiguredFeature<?,?>>	getFeature()	Returns the holder of the feature which will be placed, possibly null.
BlockPos	getPos()	Returns the coordinates of the sapling attempting to grow.
RandomSource	getRandomSource()	Returns the random source which initiated the sapling growth.
void	setFeature(@Nullable Holder<ConfiguredFeature<?,?>> feature)
void	setFeature(ResourceKey<ConfiguredFeature<?,?>> featureKey)

Methods inherited from class net.minecraftforge.event.level.LevelEvent

getLevel

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

randomSource

private final RandomSource randomSource

pos

private final BlockPos pos

feature

@Nullable
private @Nullable Holder<ConfiguredFeature<?,?>> feature

Constructor Details

SaplingGrowTreeEvent

@Deprecated(forRemoval=true,
            since="1.19.2")
public SaplingGrowTreeEvent(LevelAccessor level,
 RandomSource randomSource,
 BlockPos pos)

Deprecated, for removal: This API element is subject to removal in a future version.

SaplingGrowTreeEvent

public SaplingGrowTreeEvent(LevelAccessor level,
 RandomSource randomSource,
 BlockPos pos,
 @Nullable
 @Nullable Holder<ConfiguredFeature<?,?>> feature)

Method Details

getRandomSource

public RandomSource getRandomSource()

Returns the random source which initiated the sapling growth.

Returns:

the random source which initiated the sapling growth

getPos

public BlockPos getPos()

Returns the coordinates of the sapling attempting to grow.

Returns:

the coordinates of the sapling attempting to grow

getFeature

@Nullable
public @Nullable Holder<ConfiguredFeature<?,?>> getFeature()

Returns the holder of the feature which will be placed, possibly null.

Returns:

the holder of the feature which will be placed, possibly null

setFeature

public void setFeature(@Nullable
 @Nullable Holder<ConfiguredFeature<?,?>> feature)

Parameters:

feature - a Holder referencing a tree feature to be placed instead of the current feature.

setFeature

public void setFeature(ResourceKey<ConfiguredFeature<?,?>> featureKey)

Parameters:

featureKey - a ResourceKey referencing a tree feature to be placed instead of the current feature.