Home Commands Examples Getting Started With Scripts Global Keywords
BlockBreakEvent BlockEvent BlockToolModificationEvent EntityPlaceBlockEvent FarmlandTrampleEvent NeighborBlockNotifyEvent PortalSpawnEvent
DetonateExplosionEvent DifficultyChangeEvent Event EventResult ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
BlockEvent EntityPlaceBlockEvent
Next

BlockToolModificationEvent

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

script.zs
import crafttweaker.neoforge.api.event.block.BlockToolModificationEvent;

Extends

BlockToolModificationEvent extends BlockEvent.

Implements

BlockToolModificationEvent implements the following interfaces:

ICancellableEvent

Listening to the event

This event can be listened to like so:

script.zs
events.register<crafttweaker.neoforge.api.event.block.BlockToolModificationEvent>(event => {
    println("BlockToolModificationEvent ran!");
});

Members

cancel
cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// BlockToolModificationEvent.cancel();
event.cancel();
canceled
Getter
script.zs
// BlockToolModificationEvent.canceled as bool
event.canceled

Return Type: bool

Setter
script.zs
// BlockToolModificationEvent.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel Type: bool
canceled() as bool
script.zs
// BlockToolModificationEvent.canceled() as bool;
event.canceled();

Return Type: bool

canceled(cancel as bool)
script.zs
// BlockToolModificationEvent.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel Type: bool
context
Getter
script.zs
// BlockToolModificationEvent.context as UseOnContext
event.context

Return Type: UseOnContext

finalState
Getter
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.
script.zs
// BlockToolModificationEvent.finalState as BlockState
event.finalState

Return Type: BlockState

Setter
Sets the transformed state after tool use. If not set, will return the original state. This will be bypassed if canceled, returning null instead.
script.zs
// BlockToolModificationEvent.finalState = (state as BlockState);
event.finalState = myBlockState;

Parameters:

state Type: BlockState
hasResult
Getter
script.zs
// BlockToolModificationEvent.hasResult as bool
event.hasResult

Return Type: bool

hasResult() as bool
script.zs
// BlockToolModificationEvent.hasResult() as bool;
event.hasResult();

Return Type: bool

heldItemStack
Getter
script.zs
// BlockToolModificationEvent.heldItemStack as IItemStack
event.heldItemStack

Return Type: IItemStack

isSimulated
Getter
script.zs
// BlockToolModificationEvent.isSimulated as bool
event.isSimulated

Return Type: bool

level
Getter
script.zs
// BlockToolModificationEvent.level as LevelAccessor
event.level

Return Type: LevelAccessor

player
Getter
script.zs
// BlockToolModificationEvent.player as Player
event.player

Return Type: Player

pos
Getter
script.zs
// BlockToolModificationEvent.pos as BlockPos
event.pos

Return Type: BlockPos

result
Getter
script.zs
// BlockToolModificationEvent.result as EventResult
event.result

Return Type: EventResult

Setter
script.zs
// BlockToolModificationEvent.result = (result as EventResult);
event.result = myResult;

Parameters:

result Type: EventResult
result() as Result
script.zs
// BlockToolModificationEvent.result() as EventResult;
event.result();

Return Type: EventResult

result(result as Result)
script.zs
// BlockToolModificationEvent.result(result as EventResult);
event.result(myResult);

Parameters:

result Type: EventResult
setAllow
setAllow()
sets the event's result to allow
script.zs
// BlockToolModificationEvent.setAllow();
event.setAllow();
setDefault
setDefault()
sets the event's result to default
script.zs
// BlockToolModificationEvent.setDefault();
event.setDefault();
setDeny
setDeny()
sets the event's result to deny
script.zs
// BlockToolModificationEvent.setDeny();
event.setDeny();
state
Getter
script.zs
// BlockToolModificationEvent.state as BlockState
event.state

Return Type: BlockState

toolAction
Getter
script.zs
// BlockToolModificationEvent.toolAction as ToolAction
event.toolAction

Return Type: ToolAction

Previous
BlockEvent EntityPlaceBlockEvent
Next