Struct PluginItemUseCompletion

One server UseDone for a plugin-issued item action.

public readonly record struct PluginItemUseCompletion : IEquatable<PluginItemUseCompletion>

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

One server UseDone for a plugin-issued item action.

public PluginItemUseCompletion(long Revision, uint SourceObjectId, uint TargetObjectId, uint WeenieError)

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.
SourceObjectId uint: The item that was used.
TargetObjectId uint: The object it was used on, or zero when the use had no target.
WeenieError uint: The server's error code; zero means the use went through.

True when a use has actually completed and the server reported no error for it.

public bool IsSuccess { get; }

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; }

The item that was used.

public uint SourceObjectId { get; init; }

The object it was used on, or zero when the use had no target.

public uint TargetObjectId { get; init; }

The server's error code; zero means the use went through.

public uint WeenieError { get; init; }