Edit

Share via


PlayerInteractWithBlockBeforeEvent Class

Contains information regarding an event before a player interacts with a block.

Properties

block

read-only block: Block;

The block that will be interacted with.

Type: Block

blockFace

read-only blockFace: Direction;

The face of the block that is being interacted with.

Type: Direction

cancel

cancel: boolean;

If set to true the interaction will be cancelled.

Type: boolean

faceLocation

read-only faceLocation: Vector3;

Location relative to the bottom north-west corner of the block where the item is placed.

Type: Vector3

isFirstEvent

read-only isFirstEvent: boolean;

This value will be true if the event was triggered on players initial interaction button press and false on events triggered from holding the interaction button.

Type: boolean

itemStack

read-only itemStack?: ItemStack;

The item stack that is being used in the interaction, or undefined if empty hand.

Type: ItemStack

player

read-only player: Player;

Source Player for this event.

Type: Player