Struct PluginNavigationObject

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One world object seen from the navigation surface: who it is, where it is, and, for doors and other lockable things, whether it is open or locked.

public readonly record struct PluginNavigationObject : IEquatable<PluginNavigationObject>

Implements

IEquatable<PluginNavigationObject>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginNavigationObject(uint, string, PluginNavigationPosition)

One world object seen from the navigation surface: who it is, where it is, and, for doors and other lockable things, whether it is open or locked.

public PluginNavigationObject(uint ObjectId, string Name, PluginNavigationPosition Position)

Parameters

ObjectId uint

The server-assigned id of the object.

Name string

The object's display name, or an empty string when the client has not received one yet.

Position PluginNavigationPosition

Where the object currently stands.

Properties

HasLockState

True when the client actually knows this object's open or locked state, so a plugin can tell "closed" apart from "never reported".

public bool HasLockState { get; init; }

Property Value

bool

IsDoor

True when the object is a door.

public bool IsDoor { get; init; }

Property Value

bool

IsLocked

True when the object reports itself as locked. False both for an unlocked object and for one that never reports a lock state.

public bool IsLocked { get; init; }

Property Value

bool

IsOpen

True when the object reports itself as open. False both for a closed object and for one that never reports an open state.

public bool IsOpen { get; init; }

Property Value

bool

LockDifficulty

How hard the lock is to pick, taken from the object's lockpick resistance; zero when the object carries no such value.

public int LockDifficulty { get; init; }

Property Value

int

Name

The object's display name, or an empty string when the client has not received one yet.

public string Name { get; init; }

Property Value

string

ObjectId

The server-assigned id of the object.

public uint ObjectId { get; init; }

Property Value

uint

Position

Where the object currently stands.

public PluginNavigationPosition Position { get; init; }

Property Value

PluginNavigationPosition