MCBlockToolInteractEvent

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

Extending MCBlockEvent

Link to extending-mcblockevent

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

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: MCBlockState?

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

myMCBlockToolInteractEvent.getFinalState();

Name: getHeldItemStack

Return Type: IItemStack

ZenScript
Copy
// MCBlockToolInteractEvent.getHeldItemStack() as IItemStack

myMCBlockToolInteractEvent.getHeldItemStack();

Name: getPlayer

Return Type: MCPlayerEntity

ZenScript
Copy
// MCBlockToolInteractEvent.getPlayer() as MCPlayerEntity

myMCBlockToolInteractEvent.getPlayer();

Name: getToolType

Return Type: ToolType

ZenScript
Copy
// MCBlockToolInteractEvent.getToolType() as ToolType

myMCBlockToolInteractEvent.getToolType();

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
MCBlockToolInteractEvent.setFinalState(state as MCBlockState) as void
ParameterTypeDescription
Parameter
state
Type
MCBlockState
Description
No Description Provided
NameTypeHas GetterHas SetterDescription
Name
finalState
Type
MCBlockState?
Has Getter
true
Has Setter
true
Description
Gets the transformed state after tool use. <br /> If setFinalState is not called, it will return the original state. <br /> 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
MCPlayerEntity
Has Getter
true
Has Setter
false
Description
No Description Provided
Name
toolType
Type
ToolType
Has Getter
true
Has Setter
false
Description
No Description Provided