Package net.minecraftforge.event.world

Class BlockEvent.BlockToolInteractEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.world.BlockEvent

net.minecraftforge.event.world.BlockEvent.BlockToolInteractEvent

Enclosing class:

BlockEvent

public static class BlockEvent.BlockToolInteractEvent
extends BlockEvent

Fired when when this block is right clicked by a tool to change its state. For example: Used to determine if an axe can strip or a shovel can path. For hoes, see net.minecraft.world.item.HoeItem#TILLABLES and UseHoeEvent. 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.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 Player	player
private ItemStack	stack
private BlockState	state
private ToolAction	toolAction

Constructor Summary

Constructors

Constructor	Description
BlockToolInteractEvent(LevelAccessor world, BlockPos pos, BlockState originalState, Player player, ItemStack stack, ToolAction toolAction)

Method Summary

Modifier and Type	Method	Description
BlockState	getFinalState()	Gets the transformed state after tool use.
ItemStack	getHeldItemStack()	Gets the tool being used.
Player	getPlayer()	Gets the player using the tool.
ToolAction	getToolAction()	Gets the action being performed.
void	setFinalState(BlockState finalState)	Sets the transformed state 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

player

private final Player player

stack

private final ItemStack stack

toolAction

private final ToolAction toolAction

state

private BlockState state

Constructor Details

BlockToolInteractEvent

public BlockToolInteractEvent(LevelAccessor world,
 BlockPos pos,
 BlockState originalState,
 Player player,
 ItemStack stack,
 ToolAction toolAction)

Method Details

getPlayer

public Player getPlayer()

Gets the player using the tool.

getHeldItemStack

public ItemStack getHeldItemStack()

Gets the tool being used.

getToolAction

public ToolAction getToolAction()

Gets the action being performed.

setFinalState

public void setFinalState(BlockState finalState)

Sets the transformed state after tool use. If not set, will return the original state. This will be bypassed if canceled returning null instead.

getFinalState

public BlockState getFinalState()

Gets the transformed state after tool use. If setFinalState not called, will return the original state. This will be bypassed if canceled returning null instead.