Struct PluginVitalInfo

Namespace

AcDream.Plugin.Abstractions

Assembly

AcDream.Plugin.Abstractions.dll

One of the character's three pools -- health, stamina and mana -- as both a reading and something experience can be spent on.

public readonly record struct PluginVitalInfo : IEquatable<PluginVitalInfo>

Implements

IEquatable<PluginVitalInfo>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PluginVitalInfo(int, string, uint, uint)

One of the character's three pools -- health, stamina and mana -- as both a reading and something experience can be spent on.

public PluginVitalInfo(int Kind, string Name, uint Current, uint Maximum)

Parameters

Kind int

Which pool: 0 health, 1 stamina, 2 mana. This is the pool's own kind, the number TryGetVital(int, out PluginVitalInfo) takes; it is neither a position in Vitals, which leaves out any pool the server has not stated, nor the number the pool is named by on a request -- see StatId for that.

Name string

The pool's name as shown to the player.

Current uint

How much of the pool is left right now.

Maximum uint

The pool at full, enchantments included -- the same number MaxHealth and its two siblings report.

Properties

Base

The pool at full with every enchantment layer off. A host that does not track the split reports Maximum instead, in which case the two are the same number.

public uint Base { get; init; }

Property Value

uint

Current

How much of the pool is left right now.

public uint Current { get; init; }

Property Value

uint

ExperienceSpent

The experience already put into this pool towards the ranks it has. 0 on a host that cannot tell, and before the server has stated it.

public ulong ExperienceSpent { get; init; }

Property Value

ulong

Kind

Which pool: 0 health, 1 stamina, 2 mana. This is the pool's own kind, the number TryGetVital(int, out PluginVitalInfo) takes; it is neither a position in Vitals, which leaves out any pool the server has not stated, nor the number the pool is named by on a request -- see StatId for that.

public int Kind { get; init; }

Property Value

int

Maximum

The pool at full, enchantments included -- the same number MaxHealth and its two siblings report.

public uint Maximum { get; init; }

Property Value

uint

Name

The pool's name as shown to the player.

public string Name { get; init; }

Property Value

string

Ranks

How many times experience has been spent to raise this pool, which is the row a cost table is read at to price the next raise. 0 on a host that cannot tell, and before the server has stated it.

public uint Ranks { get; init; }

Property Value

uint

StatId

The number this pool is named by when experience is spent on it, which is what RequestAdvancement(PluginAdvancementKind, uint, ulong) takes. It is not Kind, and a zero here means the record was never filled in.

public uint StatId { get; init; }

Property Value

uint