BlockToolModificationEvent

Link to blocktoolmodificationevent

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

Extending BlockEvent

Link to extending-blockevent

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

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
// BlockToolModificationEvent.getFinalState() as BlockState?

myBlockToolModificationEvent.getFinalState();

Link to getHeldItemStack

Name: getHeldItemStack

Return Type: IItemStack

ZenScript
Copy
// BlockToolModificationEvent.getHeldItemStack() as IItemStack

myBlockToolModificationEvent.getHeldItemStack();

Name: getPlayer

Return Type: Player

ZenScript
Copy
// BlockToolModificationEvent.getPlayer() as Player

myBlockToolModificationEvent.getPlayer();

Name: getToolType

Return Type: ToolAction

ZenScript
Copy
// BlockToolModificationEvent.getToolType() as ToolAction

myBlockToolModificationEvent.getToolType();

Name: isSimulated

Return Type: boolean

ZenScript
Copy
// BlockToolModificationEvent.isSimulated() as boolean

myBlockToolModificationEvent.isSimulated();

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.

ZenScript
Copy
BlockToolModificationEvent.setFinalState(state as BlockState)
ParameterType
Parameter
state
Type
BlockState
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
Name
player
Type
Player
Has Getter
true
Has Setter
false
Description
Name
simulated
Type
boolean
Has Getter
true
Has Setter
false
Description
Name
toolAction
Type
ToolAction
Has Getter
true
Has Setter
false
Description