LeftClickBlockEvent

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.interact.LeftClickBlockEvent;

Description

This event is fired when a player left clicks while targeting a block. This event controls which of Level, BlockPos, Player) and/or the item harvesting methods will be called.
Note that if the event is canceled and the player holds down left mouse, the event will continue to fire. This is due to how vanilla calls the left click handler methods.
Also note that creative mode directly breaks the block without running any other logic.
canceled none of the above noted methods to be called.

Extends

LeftClickBlockEvent extends PlayerInteractEvent.

Implements

LeftClickBlockEvent 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.interact.LeftClickBlockEvent>(event => {
println("LeftClickBlockEvent ran!");
});

Members

Getter
script.zs
// LeftClickBlock.action as Action
event.action

Return Type: LeftClickBlockEventAction

Getter
If the interaction was on an entity, will be a BlockPos centered on the entity. If the interaction was on a block, will be the position of that block. Otherwise, will be a BlockPos centered on the player.
script.zs
// LeftClickBlock.blockPos as BlockPos
event.blockPos

Return Type: BlockPos

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

Return Type: bool

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

Parameters:

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

Return Type: bool

Getter
script.zs
// LeftClickBlock.entity as Player
event.entity

Return Type: Player

Getter
script.zs
// LeftClickBlock.entity as LivingEntity
event.entity

Return Type: LivingEntity

Getter
script.zs
// LeftClickBlock.entity as Entity
event.entity

Return Type: Entity

Getter
The face involved in this interaction. For all non-block interactions, this will return null
script.zs
// LeftClickBlock.face as Direction
event.face

Return Type: Direction

Getter
script.zs
// LeftClickBlock.hand as InteractionHand
event.hand

Return Type: InteractionHand

Getter
The stack involved in this interaction. May be empty, but will never be null.
script.zs
// LeftClickBlock.itemStack as IItemStack
event.itemStack

Return Type: IItemStack

Getter
script.zs
// LeftClickBlock.useBlock as TriState
event.useBlock

Return Type: TriState

Setter
script.zs
// LeftClickBlock.useBlock = (triggerBlock as TriState);
event.useBlock = myTriState;

Parameters:

triggerBlock Type: TriState
Getter
script.zs
// LeftClickBlock.useItem as TriState
event.useItem

Return Type: TriState

Setter
script.zs
// LeftClickBlock.useItem = (triggerItem as TriState);
event.useItem = myTriState;

Parameters:

triggerItem Type: TriState