Home Commands Examples Getting Started With Scripts Global Keywords
EntityInteractEvent EntityInteractSpecificEvent LeftClickBlockEvent LeftClickEmptyEvent PlayerInteractEvent RightClickBlockEvent RightClickEmptyEvent RightClickItemEvent
DetonateExplosionEvent DifficultyChangeEvent Event EventResult ExplosionEvent FurnaceFuelBurnTimeEvent ICancellableEvent StartExplosionEvent
NeoForgeBracketDumpers NeoForgeBracketHandlers NeoForgeBracketValidators
Previous
EntityInteractSpecificEvent LeftClickEmptyEvent
Next

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

blockPos
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
cancel()
Cancels the event. Same as setCanceled(true)
script.zs
// LeftClickBlock.cancel();
event.cancel();
canceled
Getter
script.zs
// LeftClickBlock.canceled as bool
event.canceled

Return Type: bool

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

Parameters:

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

Return Type: bool

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

Parameters:

cancel Type: bool
entity
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

face
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

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

Return Type: InteractionHand

hasResult
Getter
script.zs
// LeftClickBlock.hasResult as bool
event.hasResult

Return Type: bool

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

Return Type: bool

itemStack
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

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

Return Type: EventResult

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

Parameters:

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

Return Type: EventResult

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

Parameters:

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

Return Type: EventResult

Setter
script.zs
// LeftClickBlock.useBlock = (triggerBlock as EventResult);
event.useBlock = myResult;

Parameters:

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

Return Type: EventResult

Setter
script.zs
// LeftClickBlock.useItem = (triggerItem as EventResult);
event.useItem = myResult;

Parameters:

triggerItem Type: EventResult
Previous
EntityInteractSpecificEvent LeftClickEmptyEvent
Next