Struct TooltipRow

Namespace

FishMMO.Shared

Assembly

FishMMO.Shared.dll

One row of tooltip content, kept as data rather than as formatted text.

public struct TooltipRow : IComparable<TooltipRow>

Implements

IComparable<TooltipRow>

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Fields

Color

An explicit colour for this row, overriding the one its tone resolves to.

public Color? Color

Field Value

Color?

Remarks

For content that owns its own colour as data — an item's rarity, a faction's standing, a resource attribute's bar colour. Everything else should use a tone and let the renderer decide.

Delta

The change this row's value represents, already formatted with its sign (e.g. "+1.2s").

public string Delta

Field Value

string

Remarks

Separate from Value because a preview draws it as its own chip beside the value, in a colour taken from DeltaTone. Folding it into the value string is what made the old crafting preview unreadable: "Cooldown: 3.7s (+1.2s)" in one colour tells the player nothing at a glance.

DeltaTone

How the delta reads: an improvement, a penalty, or nothing in particular.

public TooltipTone DeltaTone

Field Value

TooltipTone

Highlight

A background highlight behind the row's text, when it has one.

public Color? Highlight

Field Value

Color?

Icon

An icon to draw beside the row, when it has one.

public Sprite Icon

Field Value

Sprite

Kind

What the row means.

public TooltipRowKind Kind

Field Value

TooltipRowKind

Label

The row's text, or the left column of a Stat.

public string Label

Field Value

string

Priority

Sort priority. Lower sorts first; ties keep insertion order.

public int Priority

Field Value

int

Style

Character styling on top of the tone.

public TooltipStyle Style

Field Value

TooltipStyle

Tone

How the row itself reads.

public TooltipTone Tone

Field Value

TooltipTone

Value

The right column of a stat row. Null for every other kind.

public string Value

Field Value

string

Methods

CompareTo(TooltipRow)

Sorts by priority, then by insertion order.

public int CompareTo(TooltipRow other)

Parameters

other TooltipRow

Returns

int