Package net.neoforged.neoforge.event.level

Class BlockEvent.BlockToolModificationEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.level.BlockEvent

net.neoforged.neoforge.event.level.BlockEvent.BlockToolModificationEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

Enclosing class:

BlockEvent

public static class BlockEvent.BlockToolModificationEvent
extends BlockEvent
implements net.neoforged.bus.api.ICancellableEvent

Fired when a block is right-clicked by a tool to change its state. For example: Used to determine if an axe can strip, a shovel can path, or a hoe can till.

Care must be taken to ensure level-modifying events are only performed if isSimulated() returns false.

This event is ICancellableEvent. If canceled, this will prevent the tool from changing the block's state.

Nested Class Summary

Nested classes/interfaces inherited from class net.neoforged.neoforge.event.level.BlockEvent

BlockEvent.BlockToolModificationEvent, BlockEvent.BreakEvent, BlockEvent.EntityMultiPlaceEvent, BlockEvent.EntityPlaceEvent, BlockEvent.FarmlandTrampleEvent, BlockEvent.FluidPlaceBlockEvent, BlockEvent.NeighborNotifyEvent, BlockEvent.PortalSpawnEvent

Field Summary

Fields

Modifier and Type	Field	Description
private final UseOnContext	context
private final boolean	simulate
private BlockState	state
private final ToolAction	toolAction

Constructor Summary

Constructors

Constructor	Description
BlockToolModificationEvent(BlockState originalState, UseOnContext context, ToolAction toolAction, boolean simulate)

Method Summary

Modifier and Type	Method	Description
UseOnContext	getContext()	Returns the nonnull use on context that this event was performed in.
BlockState	getFinalState()	Returns the state to transform the block into after tool use.
ItemStack	getHeldItemStack()
@Nullable Player	getPlayer()
ToolAction	getToolAction()
boolean	isSimulated()	Returns true if this event should not perform any actions that modify the level.
void	setFinalState(@Nullable BlockState finalState)	Sets the state to transform the block into after tool use.

Methods inherited from class net.neoforged.neoforge.event.level.BlockEvent

getLevel, getPos, getState

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

context

private final UseOnContext context

toolAction

private final ToolAction toolAction

simulate

private final boolean simulate

state

private BlockState state

Constructor Details

BlockToolModificationEvent

public BlockToolModificationEvent(BlockState originalState,
 UseOnContext context,
 ToolAction toolAction,
 boolean simulate)

Method Details

getPlayer

@Nullable
public @Nullable Player getPlayer()

Returns:

the player using the tool. May be null based on what was provided by the use on context.

getHeldItemStack

public ItemStack getHeldItemStack()

Returns:

the tool being used

getToolAction

public ToolAction getToolAction()

Returns:

the action being performed

isSimulated

public boolean isSimulated()

Returns true if this event should not perform any actions that modify the level. If false, then level-modifying actions can be performed.

Returns:

true if this event should not perform any actions that modify the level. If false, then level-modifying actions can be performed.

getContext

public UseOnContext getContext()

Returns the nonnull use on context that this event was performed in.

Returns:

the nonnull use on context that this event was performed in

setFinalState

public void setFinalState(@Nullable
 @Nullable BlockState finalState)

Sets the state to transform the block into after tool use.

Parameters:

finalState - the state to transform the block into after tool use

See Also:

• getFinalState()

getFinalState

public BlockState getFinalState()

Returns the state to transform the block into after tool use. If setFinalState(BlockState) is not called, this will return the original state. If ICancellableEvent.isCanceled() is true, this value will be ignored and the tool action will be canceled.

Returns:

the state to transform the block into after tool use