Struct PluginNavigationSnapshot

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

The local movement state sampled atomically by a plugin tick.

public readonly record struct PluginNavigationSnapshot : IEquatable<PluginNavigationSnapshot>

Implements

IEquatable<PluginNavigationSnapshot>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginNavigationSnapshot(bool, bool, uint, PluginNavigationPosition, bool, bool)

The local movement state sampled atomically by a plugin tick.

public PluginNavigationSnapshot(bool IsAvailable, bool IsPortalSpace, uint LocalObjectId, PluginNavigationPosition Position, bool IsMoving, bool IsAirborne)

Parameters

IsAvailable bool

True when a session is in the world and the remaining fields carry real values. When it is false every other field is at its default.

IsPortalSpace bool

True while the player is in transit through portal space, after leaving one place and before arriving at the next.

LocalObjectId uint

The player character's own object id.

Position PluginNavigationPosition

The player's live locally predicted position, updated every frame.

IsMoving bool

True when the player is actually moving or is holding a movement input.

IsAirborne bool

True when the player has no ground under foot.

Properties

ConfirmedPosition

The last position the server confirmed, as opposed to the locally predicted Position. Equal to Position when no server position has been accepted yet.

public PluginNavigationPosition ConfirmedPosition { get; init; }

Property Value

PluginNavigationPosition

ConfirmedPositionRevision

A counter that grows every time the server confirms a new position, so a plugin can tell a fresh confirmation from a repeat. Zero when nothing has been confirmed yet.

public ulong ConfirmedPositionRevision { get; init; }

Property Value

ulong

IsAirborne

True when the player has no ground under foot.

public bool IsAirborne { get; init; }

Property Value

bool

IsAvailable

True when a session is in the world and the remaining fields carry real values. When it is false every other field is at its default.

public bool IsAvailable { get; init; }

Property Value

bool

IsMoving

True when the player is actually moving or is holding a movement input.

public bool IsMoving { get; init; }

Property Value

bool

IsPortalSpace

True while the player is in transit through portal space, after leaving one place and before arriving at the next.

public bool IsPortalSpace { get; init; }

Property Value

bool

LocalObjectId

The player character's own object id.

public uint LocalObjectId { get; init; }

Property Value

uint

Position

The player's live locally predicted position, updated every frame.

public PluginNavigationPosition Position { get; init; }

Property Value

PluginNavigationPosition

Revision

A host-local monotonic revision for this complete navigation snapshot. It changes whenever any snapshot field changes and is useful for consumers that need to coalesce updates without comparing all fields.

public ulong Revision { get; init; }

Property Value

ulong