Struct PluginAllegianceSnapshot

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

Normalized allegiance state known by the current session.

public readonly record struct PluginAllegianceSnapshot : IEquatable<PluginAllegianceSnapshot>

Implements

IEquatable<PluginAllegianceSnapshot>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginAllegianceSnapshot(long, bool, string, uint, uint, uint, uint)

Normalized allegiance state known by the current session.

public PluginAllegianceSnapshot(long Revision, bool IsKnown, string Name, uint Rank, uint MemberCount, uint VassalCount, uint MonarchObjectId)

Parameters

Revision long

A number that grows whenever any of this changes.

IsKnown bool

True once the server has stated the allegiance this session; everything else is empty or zero until then.

Name string

The allegiance's name; empty when it has none.

Rank uint

The character's own rank in the allegiance.

MemberCount uint

How many characters the whole allegiance holds, the monarch included.

VassalCount uint

How many characters are sworn beneath this character, counting their vassals and theirs all the way down: the character's followers.

MonarchObjectId uint

The monarch's character object id, or zero when there is none.

Properties

HasMonarch

True when a monarch identity is available.

public bool HasMonarch { get; }

Property Value

bool

IsKnown

True once the server has stated the allegiance this session; everything else is empty or zero until then.

public bool IsKnown { get; init; }

Property Value

bool

MemberCount

How many characters the whole allegiance holds, the monarch included.

public uint MemberCount { get; init; }

Property Value

uint

Monarch

Who the monarch is: the character itself when it heads the allegiance. Null when the character is in no allegiance, before the server has stated it, and on a host that does not report it.

public PluginAllegianceMember? Monarch { get; init; }

Property Value

PluginAllegianceMember?

MonarchObjectId

The monarch's character object id, or zero when there is none.

public uint MonarchObjectId { get; init; }

Property Value

uint

Name

The allegiance's name; empty when it has none.

public string Name { get; init; }

Property Value

string

Patron

Who the character is sworn to. Null for a monarch, for a character in no allegiance, before the server has stated it, and on a host that does not report it.

public PluginAllegianceMember? Patron { get; init; }

Property Value

PluginAllegianceMember?

Rank

The character's own rank in the allegiance.

public uint Rank { get; init; }

Property Value

uint

Revision

A number that grows whenever any of this changes.

public long Revision { get; init; }

Property Value

long

VassalCount

How many characters are sworn beneath this character, counting their vassals and theirs all the way down: the character's followers.

public uint VassalCount { get; init; }

Property Value

uint

Vassals

The characters sworn directly to this one, as the server listed them. Empty when there are none, before the server has stated the allegiance, and on a host that does not report them.

public IReadOnlyList<PluginAllegianceMember> Vassals { get; init; }

Property Value

IReadOnlyList<PluginAllegianceMember>