BlockGrowEvent
Namespace Mc.Scripting.Events · Kind struct (ref)
public ref struct BlockGrowEvent : IEventA 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.
Constructors
Section titled “Constructors”| 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). |
Constructor
Section titled “Constructor”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 |
Properties
Section titled “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 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. |
BlockState
Section titled “BlockState”public BlockState BlockState { get; }The current state.
Cancelled
Section titled “Cancelled”public bool Cancelled { get; set; }Cancelling stops lower-priority handlers (unless they opt in) and the action itself.
NewState
Section titled “NewState”public BlockState NewState { get; }The state after growth.
public BlockPos Pos { get; }The block.
public World World { get; }The dimension.
CatalogueId
Section titled “CatalogueId”public static ushort CatalogueId { get; }Catalogue id (stable ABI).
IsCancellable
Section titled “IsCancellable”public static bool IsCancellable { get; }Whether handlers can cancel the event.
public static string Key { get; }Registry key of the event.
See also
Section titled “See also”BlockPos · BlockState · IEvent · World