Struct PluginActivationCompletion

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The outcome of a world-object activation (portal, door, NPC, or other interactable landscape object). This reports how the activation completed, including failure and interruption states.

public readonly record struct PluginActivationCompletion : IEquatable<PluginActivationCompletion>

Implements

IEquatable<PluginActivationCompletion>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginActivationCompletion(long, uint, PluginActivationOutcome, uint)

The outcome of a world-object activation (portal, door, NPC, or other interactable landscape object). This reports how the activation completed, including failure and interruption states.

public PluginActivationCompletion(long Revision, uint ObjectId, PluginActivationOutcome Outcome, uint WeenieError)

Parameters

Revision long

Counts up by one for every completion, so a plugin can tell a fresh one from one it has already seen. Zero means nothing has completed yet.

ObjectId uint

The object that was activated.

Outcome PluginActivationOutcome

The activation outcome.

WeenieError uint

The server's error code, when applicable; zero means success.

Properties

IsSuccess

True when the activation completed successfully with no error.

public bool IsSuccess { get; }

Property Value

bool

ObjectId

The object that was activated.

public uint ObjectId { get; init; }

Property Value

uint

Outcome

The activation outcome.

public PluginActivationOutcome Outcome { get; init; }

Property Value

PluginActivationOutcome

Revision

Counts up by one for every completion, so a plugin can tell a fresh one from one it has already seen. Zero means nothing has completed yet.

public long Revision { get; init; }

Property Value

long

WeenieError

The server's error code, when applicable; zero means success.

public uint WeenieError { get; init; }

Property Value

uint