TickStartEvent
Namespace Mc.Scripting.Events · Kind struct (ref)
public ref struct TickStartEvent : IEventFired at the start of every server tick.
| Id | 3 |
| Key | mc:tick_start |
| Cancellable | no |
| Fired by the engine | yes |
| Field | Type | Handlers may write | Description |
|---|---|---|---|
Tick |
ulong |
no (readonly) | The tick number. |
Constructors
Section titled “Constructors”| Member | Description |
|---|---|
TickStartEvent(ulong tick) |
Creates the event (for firing it from a plugin; native code builds its own). |
Constructor
Section titled “Constructor”public TickStartEvent(ulong tick)Creates the event (for firing it from a plugin; native code builds its own). Signature of API 1.0.
Parameters
| Name | Type | Description |
|---|---|---|
tick |
ulong |
Properties
Section titled “Properties”| Member | Description |
|---|---|
ulong Tick { get; } |
The tick number. |
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 ulong Tick { get; }The tick number.
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.