BlockBreakEvent

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.forge.api.event.block.BlockBreakEvent;

Extends

BlockBreakEvent extends BlockEvent.

Listening to the event

This event can be listened to like so:

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

Members

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

Return Type: bool

cancelable() as bool
script.zs
// BreakEvent.cancelable() as bool;
event.cancelable();

Return Type: bool

Getter
script.zs
// BreakEvent.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

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

Return Type: bool

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

Parameters:

cancel Type: bool
Getter
script.zs
// BreakEvent.expToDrop as int
event.expToDrop

Return Type: int

Setter
script.zs
// BreakEvent.expToDrop = (exp as int);
event.expToDrop = myInt;

Parameters:

exp Type: int
Getter
script.zs
// BreakEvent.hasResult as bool
event.hasResult

Return Type: bool

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

Return Type: bool

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

Return Type: LevelAccessor

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

Return Type: Player

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

Return Type: BlockPos

Getter
script.zs
// BreakEvent.result as Result
event.result

Return Type: EventResult

Setter
script.zs
// BreakEvent.result = (result as Result);
event.result = myResult;

Parameters:

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

Return Type: EventResult

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

Parameters:

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

Return Type: BlockState