Struct PluginTrackedEnchantment

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One spell effect the client believes is currently running on a target, with the time left before it lapses.

public readonly record struct PluginTrackedEnchantment : IEquatable<PluginTrackedEnchantment>

Implements

IEquatable<PluginTrackedEnchantment>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginTrackedEnchantment(uint, uint, uint, int, bool, double)

One spell effect the client believes is currently running on a target, with the time left before it lapses.

public PluginTrackedEnchantment(uint TargetObjectId, uint SpellId, uint Family, int Quality, bool IsUntargeted, double SecondsRemaining)

Parameters

TargetObjectId uint

The object the effect is running on.

SpellId uint

The spell that produced the effect.

Family uint

The spell's family group. Spells in one family replace each other rather than stacking, so this is what a plugin compares to decide whether a re-cast would overwrite an effect already in place.

Quality int

The spell's difficulty rating as the client's spell table reports it.

IsUntargeted bool

True when the spell takes no target of its own (a self or area effect).

SecondsRemaining double

Seconds left before the effect lapses, never below zero.

Properties

Family

The spell's family group. Spells in one family replace each other rather than stacking, so this is what a plugin compares to decide whether a re-cast would overwrite an effect already in place.

public uint Family { get; init; }

Property Value

uint

IsUntargeted

True when the spell takes no target of its own (a self or area effect).

public bool IsUntargeted { get; init; }

Property Value

bool

Quality

The spell's difficulty rating as the client's spell table reports it.

public int Quality { get; init; }

Property Value

int

SecondsRemaining

Seconds left before the effect lapses, never below zero.

public double SecondsRemaining { get; init; }

Property Value

double

SpellId

The spell that produced the effect.

public uint SpellId { get; init; }

Property Value

uint

TargetObjectId

The object the effect is running on.

public uint TargetObjectId { get; init; }

Property Value

uint