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



## Importare la Classe

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


## Metodi

:::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)
```

| Parametro | Tipo                                        |
| --------- | ------------------------------------------- |
| state     | [BlockState](/vanilla/api/block/BlockState) |


:::


## Proprietà

| Nome          | Tipo                                             | Ha Getter | Ha Setter | Descrizione                                                                                                                                                                                          |
| ------------- | ------------------------------------------------ | --------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| finalState    | [BlockState](/vanilla/api/block/BlockState)?     | sì        | sì        | 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)       | sì        | no        |                                                                                                                                                                                                      |
| player        | [Player](/vanilla/api/entity/type/player/Player) | sì        | no        |                                                                                                                                                                                                      |
| toolAction    | [ToolAction](/forge/api/tool/ToolAction)         | sì        | no        |                                                                                                                                                                                                      |



Nome	Tipo	Ha Getter	Ha Setter	Descrizione
Nome finalState	Tipo BlockState?	Ha Getter sì	Ha Setter sì	Descrizione 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.
Nome heldItemStack	Tipo IItemStack	Ha Getter sì	Ha Setter no	Descrizione
Nome player	Tipo Player	Ha Getter sì	Ha Setter no	Descrizione
Nome toolAction	Tipo ToolAction	Ha Getter sì	Ha Setter no	Descrizione