Class ToolTip

Namespace

RichHudFramework.UI

Assembly

RichHudClient.dll

Class used to define tooltips attached to the RHF cursor.

Set via the ToolTip property of the given UI element, or registered to RegisterToolTip(ToolTip) manually in HandleInput() every input tick.

The first tooltip registered takes precedence.

public class ToolTip

Inheritance

object

ToolTip

Constructors

ToolTip()

public ToolTip()

Fields

DefaultBG

public static readonly Color DefaultBG

Field Value

Color

DefaultText

public static readonly GlyphFormat DefaultText

Field Value

GlyphFormat

GetToolTipFunc

Callback delegate used by the API to retrieve tooltip information

public readonly Func<MyTuple<List<MyTuple<StringBuilder, MyTuple<byte, float, Vector2I, Color>>>, Color?>> GetToolTipFunc

Field Value

Func<MyTuple<List<MyTuple<StringBuilder, MyTuple<byte, float, Vector2I, Color>>>, Color?>>

OrangeWarningBG

public static readonly Color OrangeWarningBG

Field Value

Color

RedWarningBG

public static readonly Color RedWarningBG

Field Value

Color

bgColor

Color of the text background

public Color? bgColor

Field Value

Color?

text

Text to be assigned to the tooltip. Multiline tooltips are allowed, but are not wrapped.

public RichText text

Field Value

RichText

Operators

implicit operator ToolTip(RichText)

Implicitly converts RichText to ToolTip

public static implicit operator ToolTip(RichText text)

Parameters

text RichText

Returns

ToolTip

implicit operator ToolTip(string)

Implicitly converts string to ToolTip

public static implicit operator ToolTip(string text)

Parameters

text string

Returns

ToolTip