Struct PluginLootContainer

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One nearby corpse a plugin could loot, with how far away it is and where it stands in the client's open-container cycle.

public readonly record struct PluginLootContainer : IEquatable<PluginLootContainer>

Implements

IEquatable<PluginLootContainer>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginLootContainer(uint, uint, string, float, bool, bool, bool)

One nearby corpse a plugin could loot, with how far away it is and where it stands in the client's open-container cycle.

public PluginLootContainer(uint ObjectId, uint WeenieClassId, string Name, float Distance, bool HasBeenOpened, bool IsRequested, bool IsCurrent)

Parameters

ObjectId uint

The corpse's object id.

WeenieClassId uint

The corpse's class id.

Name string

The corpse's display name.

Distance float

Straight-line distance from the local player in metres, centre to centre and height included -- the same measure Distance uses, so a corpse one floor down does not read as being at your feet.

HasBeenOpened bool

True when this session has already opened that corpse at least once.

IsRequested bool

True when the client has asked to open this corpse and is still waiting for the server.

IsCurrent bool

True when this corpse is the one currently open.

Properties

Distance

Straight-line distance from the local player in metres, centre to centre and height included -- the same measure Distance uses, so a corpse one floor down does not read as being at your feet.

public float Distance { get; init; }

Property Value

float

HasBeenOpened

True when this session has already opened that corpse at least once.

public bool HasBeenOpened { get; init; }

Property Value

bool

HasPosition

Whether Position carries a real place in the world. A corpse the client knows of but cannot place has none.

public bool HasPosition { get; init; }

Property Value

bool

IsAppraisalAnswered

True once the server has answered an appraisal of this corpse, successfully or not. A corpse the server no longer has (one that decayed while the character was away) is answered with nothing, so it never becomes IsIdentified; a looter waiting on the description can stop waiting when this is true. Always true when IsIdentified is.

public bool IsAppraisalAnswered { get; init; }

Property Value

bool

IsCurrent

True when this corpse is the one currently open.

public bool IsCurrent { get; init; }

Property Value

bool

IsGeneratedRare

True when the corpse is flagged as holding a generated rare.

public bool IsGeneratedRare { get; init; }

Property Value

bool

IsIdentified

True once the client holds the corpse's appraisal text, which is what fills LongDescription.

public bool IsIdentified { get; init; }

Property Value

bool

IsRequested

True when the client has asked to open this corpse and is still waiting for the server.

public bool IsRequested { get; init; }

Property Value

bool

LongDescription

The corpse's long description, which only arrives with an appraisal; an empty string until then.

public string LongDescription { get; init; }

Property Value

string

Name

The corpse's display name.

public string Name { get; init; }

Property Value

string

ObjectId

The corpse's object id.

public uint ObjectId { get; init; }

Property Value

uint

Position

Where the corpse is, which is what lets a looter ask how far round the character would have to turn to face it.

public PluginNavigationPosition Position { get; init; }

Property Value

PluginNavigationPosition

WeenieClassId

The corpse's class id.

public uint WeenieClassId { get; init; }

Property Value

uint