Package net.minecraftforge.event.world

Class BlockEvent.BlockToolModificationEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.world.BlockEvent

net.minecraftforge.event.world.BlockEvent.BlockToolModificationEvent

Direct Known Subclasses:

BlockEvent.BlockToolInteractEvent

Enclosing class:

BlockEvent

public static class BlockEvent.BlockToolModificationEvent
extends BlockEvent

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 world-modifying events are only performed if isSimulated() returns true.

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

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.event.world.BlockEvent

BlockEvent.BlockToolInteractEvent, BlockEvent.BlockToolModificationEvent, BlockEvent.BreakEvent, BlockEvent.CreateFluidSourceEvent, BlockEvent.CropGrowEvent, BlockEvent.EntityMultiPlaceEvent, BlockEvent.EntityPlaceEvent, BlockEvent.FarmlandTrampleEvent, BlockEvent.FluidPlaceBlockEvent, BlockEvent.NeighborNotifyEvent, BlockEvent.PortalSpawnEvent

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 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)
BlockToolModificationEvent(LevelAccessor level, BlockPos pos, BlockState originalState, ToolAction toolAction)

Method Summary

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

Methods inherited from class net.minecraftforge.event.world.BlockEvent

getPos, getState, getWorld

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

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

Methods inherited from class java.lang.Object

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

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,
 @Nonnull
 UseOnContext context,
 ToolAction toolAction,
 boolean simulate)

BlockToolModificationEvent

BlockToolModificationEvent(LevelAccessor level,
 BlockPos pos,
 BlockState originalState,
 ToolAction toolAction)

Method Details

getPlayer

@Nullable
public 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 world. If false, then world-modifying actions can be performed.

Returns:

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

getContext

@Nullable
public UseOnContext getContext()

Returns the nullable use on context that this event was performed in. Starting in 1.19, this will never be null.

Returns:

the nullable use on context that this event was performed in

setFinalState

public void setFinalState(@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 Event.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