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.

import crafttweaker.forge.api.event.block.BlockToolModificationEvent;

Extends

BlockToolModificationEvent extends BlockEvent.

Listening to the event

This event can be listened to like so:

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

Members

Cancels the event. Same as setCanceled(true)

// BlockToolModificationEvent.cancel();
event.cancel();

// BlockToolModificationEvent.cancelable as bool
event.cancelable

Return Type: bool

// BlockToolModificationEvent.cancelable() as bool;
event.cancelable();

Return Type: bool

// BlockToolModificationEvent.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

cancel: bool Type: bool

// BlockToolModificationEvent.canceled() as bool;
event.canceled();

Return Type: bool

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

Parameters:

cancel: bool Type: bool

// BlockToolModificationEvent.context as UseOnContext
event.context

Return Type: UseOnContext

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.

// BlockToolModificationEvent.finalState as BlockState
event.finalState

Return Type: BlockState

Sets the transformed state after tool use. If not set, will return the original state. This will be bypassed if canceled, returning null instead.

// BlockToolModificationEvent.finalState = (state as BlockState);
event.finalState = myBlockState;

Parameters:

state: BlockState Type: BlockState

// BlockToolModificationEvent.hasResult as bool
event.hasResult

Return Type: bool

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

Return Type: bool

// BlockToolModificationEvent.heldItemStack as IItemStack
event.heldItemStack

Return Type: IItemStack

// BlockToolModificationEvent.isSimulated as bool
event.isSimulated

Return Type: bool

// BlockToolModificationEvent.level as LevelAccessor
event.level

Return Type: LevelAccessor

// BlockToolModificationEvent.player as Player
event.player

Return Type: Player

// BlockToolModificationEvent.pos as BlockPos
event.pos

Return Type: BlockPos

// BlockToolModificationEvent.result as Result
event.result

Return Type: EventResult

// BlockToolModificationEvent.result = (result as Result);
event.result = myResult;

Parameters:

result: EventResult Type: EventResult

// BlockToolModificationEvent.result() as Result;
event.result();

Return Type: EventResult

// BlockToolModificationEvent.result(result as Result);
event.result(myResult);

Parameters:

result: EventResult Type: EventResult

sets the event's result to allow

// BlockToolModificationEvent.setAllow();
event.setAllow();

sets the event's result to default

// BlockToolModificationEvent.setDefault();
event.setDefault();

sets the event's result to deny

// BlockToolModificationEvent.setDeny();
event.setDeny();

// BlockToolModificationEvent.state as BlockState
event.state

Return Type: BlockState

// BlockToolModificationEvent.toolAction as ToolAction
event.toolAction

Return Type: ToolAction