Struct PluginPortalTransition

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

A semantic portal or recall transition observed by the host. This is a state notification, not a raw protocol event; repeated notifications for one generation can be compared by Revision.

public readonly record struct PluginPortalTransition : IEquatable<PluginPortalTransition>

Implements

IEquatable<PluginPortalTransition>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginPortalTransition(long, long, uint, bool, bool, bool, bool)

A semantic portal or recall transition observed by the host. This is a state notification, not a raw protocol event; repeated notifications for one generation can be compared by Revision.

public PluginPortalTransition(long Revision, long Generation, uint DestinationCell, bool IsReady, bool IsMaterialized, bool IsCompleted, bool IsCancelled)

Parameters

Revision long

Generation long

DestinationCell uint

IsReady bool

IsMaterialized bool

IsCompleted bool

IsCancelled bool

Properties

DestinationCell

public uint DestinationCell { get; init; }

Property Value

uint

Generation

public long Generation { get; init; }

Property Value

long

IsActive

True while this generation has not completed or cancelled.

public bool IsActive { get; }

Property Value

bool

IsCancelled

public bool IsCancelled { get; init; }

Property Value

bool

IsCompleted

public bool IsCompleted { get; init; }

Property Value

bool

IsMaterialized

public bool IsMaterialized { get; init; }

Property Value

bool

IsReady

public bool IsReady { get; init; }

Property Value

bool

IsTerminal

True when the transition reached completion or cancellation.

public bool IsTerminal { get; }

Property Value

bool

Kind

The semantic source of this transition.

public PluginPortalTransitionKind Kind { get; init; }

Property Value

PluginPortalTransitionKind

RecallRequestRevision

The recall request revision that initiated this transition, or zero when the transition was not correlated to a plugin recall request.

public long RecallRequestRevision { get; init; }

Property Value

long

Revision

public long Revision { get; init; }

Property Value

long

Methods

IsStaleComparedTo(long)

Returns true when this notification is older than a transition revision the plugin has already processed.

public bool IsStaleComparedTo(long handledRevision)

Parameters

handledRevision long

Returns

bool