ChunkUnloadEvent
Namespace Mc.Scripting.Events · Kind struct (ref)
public ref struct ChunkUnloadEvent : IEventA chunk is about to be unloaded.
| Id | 51 |
| Key | mc:chunk_unload |
| Cancellable | no |
| Fired by the engine | yes |
| Field | Type | Handlers may write | Description |
|---|---|---|---|
Dimension |
int |
no (readonly) | Dimension index. |
X |
int |
no (readonly) | Chunk x. |
Z |
int |
no (readonly) | Chunk z. |
Constructors
Section titled “Constructors”| Member | Description |
|---|---|
ChunkUnloadEvent(int dimension, int x, int z) |
Creates the event (for firing it from a plugin; native code builds its own). |
Constructor
Section titled “Constructor”public ChunkUnloadEvent(int dimension, int x, int z)Creates the event (for firing it from a plugin; native code builds its own). Signature of API 1.0.
Parameters
| Name | Type | Description |
|---|---|---|
dimension |
int |
|
x |
int |
|
z |
int |
Properties
Section titled “Properties”| Member | Description |
|---|---|
int Dimension { get; } |
Dimension index. |
int X { get; } |
Chunk x. |
int Z { get; } |
Chunk z. |
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. |
Dimension
Section titled “Dimension”public int Dimension { get; }Dimension index.
public int X { get; }Chunk x.
public int Z { get; }Chunk z.
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.