BlockBurnEvent

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

public ref struct BlockBurnEvent : IEvent

Fire is about to destroy a block. Cancel to keep it.

Event

Id	182
Key	mc:block_burn
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
World	world	no (readonly)	The dimension.
Pos	BlockPos	no (readonly)	The burning block.
BlockState	blockstate	no (readonly)	Its state.

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

Constructors

Member	Description
BlockBurnEvent(World world, BlockPos pos, BlockState blockState)	Creates the event (for firing it from a plugin; native code builds its own).

Constructor

public BlockBurnEvent(World world, BlockPos pos, BlockState blockState)

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

Parameters

Name	Type	Description
world	World
pos	BlockPos
blockState	BlockState

Properties

Member	Description
BlockState BlockState { get; }	Its state.
bool Cancelled { get; set; }	Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
BlockPos Pos { get; }	The burning 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.

BlockState

public BlockState BlockState { get; }

Its state.

Cancelled

public bool Cancelled { get; set; }

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

Pos

public BlockPos Pos { get; }

The burning 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

BlockPos · BlockState · IEvent · World