Struct PluginCastCompletion

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The outcome the server reported for the most recent spell the local player finished casting. It is a single latched slot, not a queue: each new completion overwrites the previous one.

public readonly record struct PluginCastCompletion : IEquatable<PluginCastCompletion>

Implements

IEquatable<PluginCastCompletion>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginCastCompletion(long, uint, uint, uint)

The outcome the server reported for the most recent spell the local player finished casting. It is a single latched slot, not a queue: each new completion overwrites the previous one.

public PluginCastCompletion(long Revision, uint SpellId, uint TargetObjectId, uint WeenieError)

Parameters

Revision long

Counts up by one every time a new cast completes, so a plugin can tell a fresh completion from one it has already seen. Zero means no cast has completed yet this session.

SpellId uint

The spell that finished casting.

TargetObjectId uint

The object the spell was cast at, or zero for an untargeted spell.

WeenieError uint

The server's error code for the cast; zero means the server accepted it.

Properties

IsSuccess

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

public bool IsSuccess { get; }

Property Value

bool

Revision

Counts up by one every time a new cast completes, so a plugin can tell a fresh completion from one it has already seen. Zero means no cast has completed yet this session.

public long Revision { get; init; }

Property Value

long

SpellId

The spell that finished casting.

public uint SpellId { get; init; }

Property Value

uint

TargetObjectId

The object the spell was cast at, or zero for an untargeted spell.

public uint TargetObjectId { get; init; }

Property Value

uint

WeenieError

The server's error code for the cast; zero means the server accepted it.

public uint WeenieError { get; init; }

Property Value

uint