Package net.minecraftforge.event.level
Class BlockEvent.BlockToolModificationEvent
java.lang.Object
net.minecraftforge.eventbus.api.Event
net.minecraftforge.event.level.BlockEvent
net.minecraftforge.event.level.BlockEvent.BlockToolModificationEvent
- Enclosing class:
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 level-modifying events are only performed if isSimulated()
returns false
.
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.level.BlockEvent
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
Modifier and TypeFieldDescriptionprivate final UseOnContext
private final boolean
private BlockState
private final ToolAction
-
Constructor Summary
ConstructorDescriptionBlockToolModificationEvent
(BlockState originalState, @NotNull UseOnContext context, ToolAction toolAction, boolean simulate) -
Method Summary
Modifier and TypeMethodDescription@NotNull UseOnContext
Returns the nonnull use on context that this event was performed in.Returns the state to transform the block into after tool use.@Nullable Player
boolean
Returnstrue
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.minecraftforge.event.level.BlockEvent
getLevel, getPos, getState
Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult
-
Field Details
-
context
-
toolAction
-
simulate
private final boolean simulate -
state
-
-
Constructor Details
-
BlockToolModificationEvent
public BlockToolModificationEvent(BlockState originalState, @NotNull @NotNull UseOnContext context, ToolAction toolAction, boolean simulate)
-
-
Method Details
-
getPlayer
- Returns:
- the player using the tool.
May be null based on what was provided by
the use on context
.
-
getHeldItemStack
- Returns:
- the tool being used
-
getToolAction
- Returns:
- the action being performed
-
isSimulated
public boolean isSimulated()Returnstrue
if this event should not perform any actions that modify the level. Iffalse
, then level-modifying actions can be performed.- Returns:
true
if this event should not perform any actions that modify the level. Iffalse
, then level-modifying actions can be performed.
-
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
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
Returns the state to transform the block into after tool use. IfsetFinalState(BlockState)
is not called, this will return the original state. IfEvent.isCanceled()
istrue
, this value will be ignored and the tool action will be canceled.- Returns:
- the state to transform the block into after tool use
-