BlockSpreadEvent

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

public ref struct BlockSpreadEvent : IEvent

A block is spreading to a neighbour (grass, mycelium, vines, fire). Cancel to stop it.

Event

Id	183
Key	mc:block_spread
Cancellable	yes
Fired by the engine	yes

Field	Type	Handlers may write	Description
World	world	no (readonly)	The dimension.
Pos	BlockPos	no (readonly)	The target position.
Source	BlockPos	no (readonly)	The spreading block.
NewState	blockstate	no (readonly)	The state that would be placed.

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

Constructors

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

Constructor

public BlockSpreadEvent(World world, BlockPos pos, BlockPos source, 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
source	BlockPos
newState	BlockState

Properties

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

NewState

public BlockState NewState { get; }

The state that would be placed.

Pos

public BlockPos Pos { get; }

The target position.

Source

public BlockPos Source { get; }

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