BlockFormEvent

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

public ref struct BlockFormEvent : IEvent

A block is forming through the environment (snow, ice, concrete, obsidian …). Cancel to stop it.

Event

Id	185
Key	mc:block_form
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
World	world	no (readonly)	The dimension.
Pos	BlockPos	no (readonly)	The position.
BlockState	blockstate	no (readonly)	The current state.
NewState	blockstate	no (readonly)	The state that forms.

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

Constructors

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

Constructor

public BlockFormEvent(World world, BlockPos pos, BlockState blockState, BlockState newState)

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
newState	BlockState

Properties

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

The current state.

Cancelled

public bool Cancelled { get; set; }

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

NewState

public BlockState NewState { get; }

The state that forms.

Pos

public BlockPos Pos { get; }

The position.

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