UI text object that can be higlighted and selected to perform an action. More...

Inheritance diagram for UITextController:

Collaboration diagram for UITextController:

[legend]

Public Member Functions
void	Awake ()
	Initialize references. More...

void	OnSelect ()
	Trigger the selection action. More...

void	OnMouseHoverEnter ()
	Change the color and fontsize to show the text has been highlighted. More...

void	OnMouseHoverExit ()
	Change the color and fontsize to show the text has been unhighlighted. More...

Public Attributes
Color	enterColor

Color	exitColor

int	enterFontSize

int	exitFontSize

Text	text

UISelectAction	selectAction

float	delayBetweenSelectionFlashes

int	flashesBeforeAction

int	totalFlashes

int	keyboardControllerIndex

Detailed Description

UI text object that can be higlighted and selected to perform an action.

When the text object is selected, it will flash to show it has been selected.

Member Function Documentation

◆ Awake()

void UITextController.Awake ( )

Initialize references.

◆ OnMouseHoverEnter()

void UITextController.OnMouseHoverEnter ( )

Change the color and fontsize to show the text has been highlighted.

◆ OnMouseHoverExit()

void UITextController.OnMouseHoverExit ( )

Change the color and fontsize to show the text has been unhighlighted.

◆ OnSelect()

void UITextController.OnSelect ( )

Trigger the selection action.

Member Data Documentation

◆ delayBetweenSelectionFlashes

float UITextController.delayBetweenSelectionFlashes

The wait time between changing colors when the text has been selected.

◆ enterColor

Color UITextController.enterColor

Color text should be when highlighted.

◆ enterFontSize

int UITextController.enterFontSize

Size text should be when highlighted.

◆ exitColor

Color UITextController.exitColor

Color text should be when unhighlighted.

◆ exitFontSize

int UITextController.exitFontSize

Size text should be when unhighlighted.

◆ flashesBeforeAction

int UITextController.flashesBeforeAction

Add a short delay before triggering the selection action.

◆ keyboardControllerIndex

int UITextController.keyboardControllerIndex

Index into the context array.

◆ selectAction

UISelectAction UITextController.selectAction

Selection action to trigger when selected.

◆ text

Text UITextController.text

Reference to the UI Text object.

◆ totalFlashes

int UITextController.totalFlashes

Total number of flashes before giving up and calling it quits.

The documentation for this class was generated from the following file:

Assets/Scripts/UI/UITextController.cs

Public Member Functions

Public Attributes