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



## 导入类

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
import crafttweaker.api.event.block.BlockToolInteractEvent;
```


## 使用方式

:::group{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](/vanilla/api/block/BlockState)?

```zenscript
// BlockToolInteractEvent.getFinalState() as BlockState?

myBlockToolInteractEvent.getFinalState();
```

:::

:::group{name=getHeldItemStack}

Return Type: [IItemStack](/vanilla/api/item/IItemStack)

```zenscript
// BlockToolInteractEvent.getHeldItemStack() as IItemStack

myBlockToolInteractEvent.getHeldItemStack();
```

:::

:::group{name=getPlayer}

Return Type: [Player](/vanilla/api/entity/type/player/Player)

```zenscript
// BlockToolInteractEvent.getPlayer() as Player

myBlockToolInteractEvent.getPlayer();
```

:::

:::group{name=getToolType}

Return Type: [ToolAction](/forge/api/tool/ToolAction)

```zenscript
// BlockToolInteractEvent.getToolType() as ToolAction

myBlockToolInteractEvent.getToolType();
```

:::

:::group{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
BlockToolInteractEvent.setFinalState(state as BlockState)
```

| 参数    | 类型                                          |
| ----- | ------------------------------------------- |
| state | [BlockState](/vanilla/api/block/BlockState) |


:::


## 参数

| 名称            | 类型                                               | 可获得  | 可设置   | 描述                                                                                                                                                                                                   |
| ------------- | ------------------------------------------------ | ---- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| finalState    | [BlockState](/vanilla/api/block/BlockState)?     | true | true  | 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. |
| heldItemStack | [IItemstack](/vanilla/api/item/IItemStack)       | true | false |                                                                                                                                                                                                      |
| player        | [Player](/vanilla/api/entity/type/player/Player) | true | false |                                                                                                                                                                                                      |
| toolAction    | [ToolAction](/forge/api/tool/ToolAction)         | true | false |                                                                                                                                                                                                      |



名称	类型	可获得	可设置	描述
名称 finalState	类型 BlockState?	可获得 true	可设置 true	描述 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.
名称 heldItemStack	类型 IItemstack	可获得 true	可设置 false	描述
名称 player	类型 Player	可获得 true	可设置 false	描述
名称 toolAction	类型 ToolAction	可获得 true	可设置 false	描述