Skip to content

BlockGrowEvent

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

public ref struct BlockGrowEvent : IEvent

A plant is growing (crops, stems, cactus, sugar cane, …). Cancel to stop it.

Id 186
Key mc:block_grow
Cancellable yes
Fired by the engine yes
Field Type Handlers may write Description
World world no (readonly) The dimension.
Pos BlockPos no (readonly) The block.
BlockState blockstate no (readonly) The current state.
NewState blockstate no (readonly) The state after growth.

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

Member Description
BlockGrowEvent(World world, BlockPos pos, BlockState blockState, BlockState newState) Creates the event (for firing it from a plugin; native code builds its own).
public BlockGrowEvent(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
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 after growth.
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.
public BlockState BlockState { get; }

The current state.

public bool Cancelled { get; set; }

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

public BlockState NewState { get; }

The state after growth.

public BlockPos Pos { get; }

The block.

public World World { get; }

The dimension.

public static ushort CatalogueId { get; }

Catalogue id (stable ABI).

public static bool IsCancellable { get; }

Whether handlers can cancel the event.

public static string Key { get; }

Registry key of the event.

BlockPos · BlockState · IEvent · World