Struct NameplateLine
One row of an overhead nameplate.
[Serializable]
public struct NameplateLine- Inherited Members
Remarks
A value type held in a list on Nameplate: rows are written far more often than they are created — a guild name arriving, a status clearing — and a struct in a list means those writes allocate nothing and the renderer can walk the rows without chasing references.
Colour is stored as a colour plus a flag rather than as a nullable, because the plate's style is what decides an uncoloured row's colour and that decision has to be re-made whenever the style or the faction tint changes — long after the row was written.
Fields
Color
The row's colour, when HasColor is set.
public Color ColorField Value
- Color
HasColor
True when Color overrides the colour the style would give.
public bool HasColorField Value
Key
The row's identity: a NameplateSlot value, or a developer's own key.
public int KeyField Value
Remarks
Writing a row replaces the row with the same key, which is what lets a caller push a name or a status repeatedly without checking whether it is already there.
Order
Stacking order, ascending from the top of the plate.
public int OrderField Value
Scale
Font scale relative to the plate's resolved font size.
public float ScaleField Value
Text
The row's text. Rich-text markup is permitted.
public string TextField Value
Properties
Slot
The slot this row occupies, for rows written through a slot.
public NameplateSlot Slot { get; }Property Value
Methods
ResolveColor(in NameplateStyle, Color)
The colour this row is drawn in.
public Color ResolveColor(in NameplateStyle style, Color allianceTint)Parameters
styleNameplateStyleThe plate's style.
allianceTintColorThe plate's current faction-standing tint.
Returns
- Color
The row's own colour, or the colour the style gives its kind of row.