cheveron-leftPrevious
MCBlockPlaceEvent
MCCropGrowEvent
Nextcheveron-right

MCBlockToolInteractEvent

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 a log, a shovel can turn grass into a path, or a hoe can till dirt into farmland.

The event is not cancelable.

The event does not have a result.

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.event.block.MCBlockToolInteractEvent;

Extending MCBlockEvent

MCBlockToolInteractEvent extends MCBlockEvent. That means all methods available in MCBlockEvent are also available in MCBlockToolInteractEvent

Methods

getFinalState

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

Return Type: MCBlockState?

ZenScript
 Copy
// MCBlockToolInteractEvent.getFinalState() as MCBlockState?

myMCBlockToolInteractEvent.getFinalState();
getHeldItemStack

Return Type: IItemStack

ZenScript
 Copy
// MCBlockToolInteractEvent.getHeldItemStack() as IItemStack

myMCBlockToolInteractEvent.getHeldItemStack();
getPlayer

Return Type: MCPlayerEntity

ZenScript
 Copy
// MCBlockToolInteractEvent.getPlayer() as MCPlayerEntity

myMCBlockToolInteractEvent.getPlayer();
getToolType

Return Type: ToolType

ZenScript
 Copy
// MCBlockToolInteractEvent.getToolType() as ToolType

myMCBlockToolInteractEvent.getToolType();
setFinalState

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

Return Type: void

ZenScript
 Copy
MCBlockToolInteractEvent.setFinalState(state as MCBlockState) as void
ParameterTypeDescription
stateMCBlockStateNo Description Provided

Properties

NameTypeHas GetterHas SetterDescription
finalStateMCBlockState?truetrueGets the transformed state after tool use.
If setFinalState is not called, it will return the original state.
This will be bypassed if canceled, returning null instead.
heldItemStackIItemStacktruefalseNo Description Provided
playerMCPlayerEntitytruefalseNo Description Provided
toolTypeToolTypetruefalseNo Description Provided
cheveron-leftPrevious
MCBlockPlaceEvent
MCCropGrowEvent
Nextcheveron-right