Class TooltipHandler

The main behavior script for the tooltip system. This class manages the visibility of the tooltip text box and provides the interface for requesting a tooltip and closing the box again.

Inheritance

object

TooltipHandler

Namespace: AS2.UI

Assembly: .dll

Syntax

public class TooltipHandler : MonoBehaviour

Fields

childTransform

Declaration

public RectTransform childTransform

Field Value

Type	Description
RectTransform

instance

Declaration

private static TooltipHandler instance

Field Value

Type	Description
TooltipHandler

isEnabled

Declaration

private bool isEnabled

Field Value

Type	Description
bool

lastMousePosition

Declaration

private Vector2 lastMousePosition

Field Value

Type	Description
Vector2

lastTimestamp

Declaration

private float lastTimestamp

Field Value

Type	Description
float

mouseDeltaThreshold

Declaration

private readonly float mouseDeltaThreshold

Field Value

Type	Description
float

textObj

Declaration

public TextMeshProUGUI textObj

Field Value

Type	Description
TextMeshProUGUI

tooltipDelay

Declaration

public float tooltipDelay

Field Value

Type	Description
float

waitForDisplay

Declaration

private bool waitForDisplay

Field Value

Type	Description
bool

Properties

Enabled

Whether the tooltip system should be enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

Instance

The singleton tooltip instance.

Declaration

public static TooltipHandler Instance { get; }

Property Value

Type	Description
TooltipHandler

Methods

Awake()

Declaration

private void Awake()

ChangeMessage(string)

Changes the tooltip message while it is displayed.

Declaration

public void ChangeMessage(string message)

Parameters

Type	Name	Description
string	message	The new tooltip message.

Close()

Hides the tooltip until the next call to Open(string).

Declaration

public void Close()

Open(string)

Schedules the tooltip to be displayed with the given message. Should be called when the cursor enters the UI element.

Declaration

public void Open(string message)

Parameters

Type	Name	Description
string	message	The new tooltip message.

SetEnabled(bool)

Declaration

private void SetEnabled(bool newEnabled)

Parameters

Type	Name	Description
bool	newEnabled

Start()

Declaration

private void Start()

Update()

Declaration

private void Update()