BlockToolInteractEvent

Link to blocktoolinteractevent

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

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

The event does not have a result.

Importing the class

Link to 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.BlockToolInteractEvent;

Extending BlockEvent

Link to extending-blockevent

BlockToolInteractEvent extends BlockEvent. That means all methods available in BlockEvent are also available in BlockToolInteractEvent

Link to g-

Name: 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: BlockState

ZenScript
Copy
// BlockToolInteractEvent.getFinalState() as BlockState

myBlockToolInteractEvent.getFinalState();

Link to g--1

Name: getHeldItemStack

Return Type: IItemStack

ZenScript
Copy
// BlockToolInteractEvent.getHeldItemStack() as IItemStack

myBlockToolInteractEvent.getHeldItemStack();

Link to g--2

Name: getPlayer

Return Type: Player

ZenScript
Copy
// BlockToolInteractEvent.getPlayer() as Player

myBlockToolInteractEvent.getPlayer();

Link to g--3

Name: getToolType

Return Type: ToolAction

ZenScript
Copy
// BlockToolInteractEvent.getToolType() as ToolAction

myBlockToolInteractEvent.getToolType();

Link to g--4

Name: 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
BlockToolInteractEvent.setFinalState(state as BlockState) as void
ParameterTypeDescription
Parameter
state
Type
BlockState
Description
No Description Provided
NameTypeHas GetterHas SetterDescription
Name
finalState
Type
BlockState
Has Getter
true
Has Setter
true
Description
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.
Name
heldItemStack
Type
IItemStack
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
player
Type
Player
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
toolAction
Type
ToolAction
Has Getter
true
Has Setter
false
Description
No Description Provided