Struct PluginGoToReport

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The most recent walk the client planned to an object. Sequence grows by one for every walk asked for, so a plugin can tell its own from a later one. RemainingMeters is the length of route left while the walk goes on; once it has ended, the straight-line distance from the character to the object, or NaN when the client cannot tell. Reason says what the walk is doing, or why it ended.

public readonly record struct PluginGoToReport : IEquatable<PluginGoToReport>

Implements

IEquatable<PluginGoToReport>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginGoToReport(long, PluginGoToState, uint, float, int, string?)

The most recent walk the client planned to an object. Sequence grows by one for every walk asked for, so a plugin can tell its own from a later one. RemainingMeters is the length of route left while the walk goes on; once it has ended, the straight-line distance from the character to the object, or NaN when the client cannot tell. Reason says what the walk is doing, or why it ended.

public PluginGoToReport(long Sequence, PluginGoToState State, uint ObjectId, float RemainingMeters, int Replans, string? Reason)

Parameters

Sequence long

State PluginGoToState

ObjectId uint

RemainingMeters float

Replans int

Reason string

Properties

BlockedByObjectId

On a walk that ended blocked, the server object, such as a door that would not open, beside the spot where it last stopped making progress; otherwise zero.

public uint BlockedByObjectId { get; init; }

Property Value

uint

CurrentState

The current navigation state, repeated here as a stable event discriminator. This is equal to State and exists so consumers can inspect a report without relying on positional record members.

public PluginGoToState CurrentState { get; }

Property Value

PluginGoToState

ObjectId

public uint ObjectId { get; init; }

Property Value

uint

Owner

Who asked for the walk under way: a plugin's id, or "player" for a chat command; null once no walk is under way.

public string? Owner { get; init; }

Property Value

string

Reason

public string? Reason { get; init; }

Property Value

string

RemainingMeters

public float RemainingMeters { get; init; }

Property Value

float

Replans

public int Replans { get; init; }

Property Value

int

Revision

A monotonically increasing revision for this report stream. It changes whenever the reported walk sequence or state changes, allowing an event consumer to reject duplicate or stale reports.

public long Revision { get; init; }

Property Value

long

Sequence

public long Sequence { get; init; }

Property Value

long

State

public PluginGoToState State { get; init; }

Property Value

PluginGoToState