UITooltip Class Reference

Example script that can be used to show tooltips. More...

Inheritance diagram for UITooltip:

Static Public Member Functions
static void	ShowText (string tooltipText)
	Show a tooltip with the specified text. More...

Public Attributes
Camera	uiCamera
UILabel	text
UISprite	background
float	appearSpeed = 10f
bool	scalingTransitions = true

Protected Member Functions
virtual void	Start ()
	Get a list of widgets underneath the tooltip. More...
virtual void	Update ()
	Update the tooltip's alpha based on the target value. More...
virtual void	SetAlpha (float val)
	Set the alpha of all widgets. More...
virtual void	SetText (string tooltipText)
	Set the tooltip's text to the specified string. More...

Protected Attributes
Transform	mTrans
float	mTarget = 0f
float	mCurrent = 0f
Vector3	mPos
Vector3	mSize = Vector3.zero
UIWidget[]	mWidgets

Static Protected Attributes
static UITooltip	mInstance

Properties
static bool	isVisible [get]
	Whether the tooltip is currently visible. More...

Detailed Description

Example script that can be used to show tooltips.

Member Function Documentation

virtual void UITooltip.SetAlpha ( float  val )

protectedvirtual

Set the alpha of all widgets.

virtual void UITooltip.SetText ( string  tooltipText )

protectedvirtual

Set the tooltip's text to the specified string.

static void UITooltip.ShowText ( string  tooltipText )

static

Show a tooltip with the specified text.

virtual void UITooltip.Start ( )

protectedvirtual

Get a list of widgets underneath the tooltip.

virtual void UITooltip.Update ( )

protectedvirtual

Update the tooltip's alpha based on the target value.

Member Data Documentation

float UITooltip.appearSpeed = 10f

UISprite UITooltip.background

float UITooltip.mCurrent = 0f

protected

UITooltip UITooltip.mInstance

staticprotected

Vector3 UITooltip.mPos

protected

Vector3 UITooltip.mSize = Vector3.zero

protected

float UITooltip.mTarget = 0f

protected

Transform UITooltip.mTrans

protected

UIWidget [] UITooltip.mWidgets

protected

bool UITooltip.scalingTransitions = true

UILabel UITooltip.text

Camera UITooltip.uiCamera

Property Documentation

bool UITooltip.isVisible

staticget

Whether the tooltip is currently visible.

---

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

• D:/Projects/NGUI/Assets/NGUI/Scripts/UI/UITooltip.cs