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



## 导入类

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.MCBlockToolInteractEvent;
```


## Extending MCBlockEvent

MCBlockToolInteractEvent extends [MCBlockEvent](/vanilla/api/event/block/MCBlockEvent). That means all methods available in [MCBlockEvent](/vanilla/api/event/block/MCBlockEvent) are also available in MCBlockToolInteractEvent

## 使用方式

:::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: [MCBlockState](/vanilla/api/block/MCBlockState)?

```zenscript
// MCBlockToolInteractEvent.getFinalState() as MCBlockState?

myMCBlockToolInteractEvent.getFinalState();
```

:::

:::group{name=getHeldItemStack}

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

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

myMCBlockToolInteractEvent.getHeldItemStack();
```

:::

:::group{name=getPlayer}

Return Type: [MCPlayerEntity](/vanilla/api/entity/MCPlayerEntity)

```zenscript
// MCBlockToolInteractEvent.getPlayer() as MCPlayerEntity

myMCBlockToolInteractEvent.getPlayer();
```

:::

:::group{name=getToolType}

Return Type: [ToolType](/vanilla/api/tool/ToolType)

```zenscript
// MCBlockToolInteractEvent.getToolType() as ToolType

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

Return Type: void

```zenscript
MCBlockToolInteractEvent.setFinalState(state as MCBlockState) as void
```

| 参数    | 类型                                                      | 描述                      |
| ----- | ------------------------------------------------------- | ----------------------- |
| state | [MCBlockState #MC方块状态](/vanilla/api/block/MCBlockState) | No Description Provided |


:::


## 参数

| 名称            | 类型                                                           | 可获得  | 可设置   | 描述                                                                                                                                                                                                   |
| ------------- | ------------------------------------------------------------ | ---- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| finalState    | [MCBlockState](/vanilla/api/block/MCBlockState)?             | 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/items/IItemStack)                  | true | false | No Description Provided                                                                                                                                                                              |
| player        | [MCPlayerEntity #MC玩家实体](/vanilla/api/entity/MCPlayerEntity) | true | false | No Description Provided                                                                                                                                                                              |
| toolType      | [ToolType](/vanilla/api/tool/ToolType)                       | true | false | No Description Provided                                                                                                                                                                              |



名称	类型	可获得	可设置	描述
名称 finalState	类型 MCBlockState?	可获得 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	描述 No Description Provided
名称 player	类型 MCPlayerEntity #MC玩家实体	可获得 true	可设置 false	描述 No Description Provided
名称 toolType	类型 ToolType	可获得 true	可设置 false	描述 No Description Provided