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
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.
import crafttweaker.api.event.block.MCBlockToolInteractEvent;Extending MCBlockEvent
MCBlockToolInteractEvent extends MCBlockEvent. That means all methods available in MCBlockEvent are also available in MCBlockToolInteractEvent
Methods
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?
// MCBlockToolInteractEvent.getFinalState() as MCBlockState?
myMCBlockToolInteractEvent.getFinalState();Return Type: IItemStack
// MCBlockToolInteractEvent.getHeldItemStack() as IItemStack
myMCBlockToolInteractEvent.getHeldItemStack();Return Type: MCPlayerEntity
// MCBlockToolInteractEvent.getPlayer() as MCPlayerEntity
myMCBlockToolInteractEvent.getPlayer();Return Type: ToolType
// MCBlockToolInteractEvent.getToolType() as ToolType
myMCBlockToolInteractEvent.getToolType();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
MCBlockToolInteractEvent.setFinalState(state as MCBlockState) as void| Parameter | Type | Description |
|---|---|---|
Parameter state | Type MCBlockState | Description No Description Provided |
Properties
| Name | Type | Has Getter | Has Setter | Description |
|---|---|---|---|---|
Name finalState | Type MCBlockState? | 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 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 |