Struct SksePluginMessage

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A message one SKSE plugin sends another.

public readonly struct SksePluginMessage : IEquatable<SksePluginMessage>

Implements

IEquatable<SksePluginMessage>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SksePluginMessage(string, uint, nint, int)

A message one SKSE plugin sends another.

public SksePluginMessage(string Sender, uint MessageType, nint Data, int Length)

Parameters

Sender string

The sending plugin, named as Subscribe(string, Action<SksePluginMessage>) describes.

MessageType uint

The sender's own number for this kind of message.

Data nint

The payload's address in this process, or 0 for a message with no payload.

Length int

The payload's length in bytes.

Properties

Data

The payload's address in this process, or 0 for a message with no payload.

public nint Data { get; init; }

Property Value

nint

Length

The payload's length in bytes.

public int Length { get; init; }

Property Value

int

MessageType

The sender's own number for this kind of message.

public uint MessageType { get; init; }

Property Value

uint

Sender

The sending plugin, named as Subscribe(string, Action<SksePluginMessage>) describes.

public string Sender { get; init; }

Property Value

string

Methods

Deconstruct(out string, out uint, out nint, out int)

public void Deconstruct(out string Sender, out uint MessageType, out nint Data, out int Length)

Parameters

Sender string

MessageType uint

Data nint

Length int

Equals(SksePluginMessage)

public bool Equals(SksePluginMessage other)

Parameters

other SksePluginMessage

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(SksePluginMessage, SksePluginMessage)

public static bool operator ==(SksePluginMessage left, SksePluginMessage right)

Parameters

left SksePluginMessage

right SksePluginMessage

Returns

bool

operator !=(SksePluginMessage, SksePluginMessage)

public static bool operator !=(SksePluginMessage left, SksePluginMessage right)

Parameters

left SksePluginMessage

right SksePluginMessage

Returns

bool