Struct ContractSnapshot

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One tracked quest contract as the client currently understands it. The text fields are empty when the client has no description for the contract in its loaded content.

public readonly record struct ContractSnapshot : IEquatable<ContractSnapshot>

Implements

IEquatable<ContractSnapshot>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ContractSnapshot(uint, uint, uint, bool, string, string, string)

One tracked quest contract as the client currently understands it. The text fields are empty when the client has no description for the contract in its loaded content.

public ContractSnapshot(uint ContractId, uint Stage, uint Progress, bool IsDisplayed, string Name = "", string Description = "", string Status = "")

Parameters

ContractId uint

The contract's id.

Stage uint

How far along the contract the character is.

Progress uint

The contract's progress counter at this stage.

IsDisplayed bool

Whether this is the contract the character has chosen to track.

Name string

The contract's title, or empty when unknown.

Description string

The contract's long description, or empty when unknown.

Status string

The one-line progress text for the current stage, or empty when the client has no description to build it from.

Properties

ContractId

The contract's id.

public uint ContractId { get; init; }

Property Value

uint

Description

The contract's long description, or empty when unknown.

public string Description { get; init; }

Property Value

string

IsDisplayed

Whether this is the contract the character has chosen to track.

public bool IsDisplayed { get; init; }

Property Value

bool

Name

The contract's title, or empty when unknown.

public string Name { get; init; }

Property Value

string

Progress

The contract's progress counter at this stage.

public uint Progress { get; init; }

Property Value

uint

Stage

How far along the contract the character is.

public uint Stage { get; init; }

Property Value

uint

Status

The one-line progress text for the current stage, or empty when the client has no description to build it from.

public string Status { get; init; }

Property Value

string