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.BlockToolModificationEvent

net.minecraftforge.event.world.BlockEvent.BlockToolInteractEvent

Enclosing class:

BlockEvent

@Deprecated(forRemoval=true,
            since="1.18.2")
public static class BlockEvent.BlockToolInteractEvent
extends BlockEvent.BlockToolModificationEvent

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

Use BlockEvent.BlockToolModificationEvent and put world-modifying actions behind if (!event.isSimulated()).

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.

This deprecated subclass event is only fired when BlockEvent.BlockToolModificationEvent.isSimulated() is false. To receive simulated events, use BlockEvent.BlockToolModificationEvent.

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 Player	player	Deprecated, for removal: This API element is subject to removal in a future version.
private final ItemStack	stack	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
BlockToolInteractEvent(BlockState originalState, UseOnContext context, ToolAction toolAction)	Deprecated, for removal: This API element is subject to removal in a future version.
BlockToolInteractEvent(LevelAccessor world, BlockPos pos, BlockState originalState, Player player, ItemStack stack, ToolAction toolAction)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
ItemStack	getHeldItemStack()	Deprecated, for removal: This API element is subject to removal in a future version.
Player	getPlayer()	Deprecated, for removal: This API element is subject to removal in a future version.

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

getContext, getFinalState, getToolAction, isSimulated, setFinalState

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

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

stack

private final ItemStack stack

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

Constructor Details

BlockToolInteractEvent

public BlockToolInteractEvent(BlockState originalState,
 @Nonnull
 UseOnContext context,
 ToolAction toolAction)

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

BlockToolInteractEvent

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

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

Method Details

getPlayer

@Nonnull
public Player getPlayer()

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

Overrides:

getPlayer in class BlockEvent.BlockToolModificationEvent

Returns:

the player using the tool, never null

getHeldItemStack

public ItemStack getHeldItemStack()

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

Overrides:

getHeldItemStack in class BlockEvent.BlockToolModificationEvent

Returns:

the tool being used