Skip to main content
Version: 1.1.1

Struct EventContext

Namespace: ReadyM.SDK.Events
Assembly: ReadyM.SDK.dll

What a networked event handler is told about the event besides its members.

public readonly struct EventContext

Inherited Members​

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties​

CancelledBy​

On Stage.Rejected, the unique ID of the mod that cancelled the event.

public string CancelledBy { get; }

Property Value​

string

Origin​

Who raised it: a player, or Server.

public PlayerId Origin { get; }

Property Value​

PlayerId

Methods​

Cancel<TReason>(TReason)​

Cancels the event, with a reason of the type its declaration named. Every later stage is skipped and the reason reaches the origin.

public void Cancel<TReason>(TReason reason)

Parameters​

reason TReason

Type Parameters​

TReason

Cancel()​

Cancels the event without a reason. Every later stage is skipped.

public void Cancel()