CustomBlockInteractEvent

Namespace Mc.Scripting.Events · Kind struct (ref)

public ref struct CustomBlockInteractEvent : IEvent

A player right-clicked a custom block (fired by the content layer after PlayerInteractBlock). Cancel to stop the block handler and the item use.

Event

Id	275
Key	mc:custom_block_interact
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
Player	player	no (readonly)	The player.
CustomId	Utf8String	no (readonly)	The id of the custom block.
World	world	no (readonly)	The dimension.
Pos	BlockPos	no (readonly)	The block.
Face	enum:BlockFace	no (readonly)	The clicked face.
Hand	enum:Hand	no (readonly)	The hand.
Item	item	no (readonly)	The item in that hand.

Set e.Cancelled = true in a handler to cancel it; lower-priority handlers are skipped unless they subscribed with receiveCancelled: true.

Constructors

Member	Description
Constructor	Creates the event (for firing it from a plugin; native code builds its own).

Constructor

public CustomBlockInteractEvent(Player player, Utf8String customId, World world, BlockPos pos, BlockFace face, Hand hand, ItemView item)

Creates the event (for firing it from a plugin; native code builds its own). Signature of API 1.0.

Parameters

Name	Type	Description
player	Player
customId	Utf8String
world	World
pos	BlockPos
face	BlockFace
hand	Hand
item	ItemView

Properties

Member	Description
bool Cancelled { get; set; }	Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
Utf8String CustomId { get; }	The id of the custom block.
BlockFace Face { get; }	The clicked face.
Hand Hand { get; }	The hand.
ItemView Item { get; }	The item in that hand.
Player Player { get; }	The player.
BlockPos Pos { get; }	The block.
World World { get; }	The dimension.
static ushort CatalogueId { get; }	Catalogue id (stable ABI).
static bool IsCancellable { get; }	Whether handlers can cancel the event.
static string Key { get; }	Registry key of the event.

Cancelled

public bool Cancelled { get; set; }

Cancelling stops lower-priority handlers (unless they opt in) and the action itself.

CustomId

public Utf8String CustomId { get; }

The id of the custom block.

Face

public BlockFace Face { get; }

The clicked face.

Hand

public Hand Hand { get; }

The hand.

Item

public ItemView Item { get; }

The item in that hand.

Player

public Player Player { get; }

The player.

Pos

public BlockPos Pos { get; }

The block.

World

public World World { get; }

The dimension.

CatalogueId

public static ushort CatalogueId { get; }

Catalogue id (stable ABI).

IsCancellable

public static bool IsCancellable { get; }

Whether handlers can cancel the event.

Key

public static string Key { get; }

Registry key of the event.

See also

BlockFace · BlockPos · Hand · IEvent · ItemView · Player · Utf8String · World