PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls Class Reference

NGUI controls for NGUIDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls:

Collaboration diagram for PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the alert controls active. More...
override void	SetMessage (string message, float duration)
	Sets the alert message and begins the fade in/out routine. More...
IEnumerator	FadeOut (Action FadedOutHandler)
	Fades out the alert line. More...
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIAlertControls
virtual void	ShowMessage (string message, float duration)
	Sets the GUI controls and shows a message. More...
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	Show ()
	Shows the controls by setting them active. More...
void	Hide ()
	Hides the controls by setting them inactive. More...

Public Attributes
UIPanel	panel
	The panel containing the alert controls. More...
UILabel	line
	The label used to show the alert message text. More...
UIButton	continueButton
	Optional continue button to close the alert immediately. More...
float	fadeOutDuration = 1
	The duration to fade out at the end of showing the alert. More...

Properties
override bool	IsVisible [get]
	Is an alert currently showing? More...
Properties inherited from PixelCrushers.DialogueSystem.AbstractUIAlertControls
abstract bool	IsVisible [get]
	Gets a value indicating whether an alert is visible. More...
virtual bool	IsDone [get]
	Has the duration passed for the currently-showing alert? More...

Additional Inherited Members
Protected Attributes inherited from PixelCrushers.DialogueSystem.AbstractUIAlertControls
float	alertDoneTime = 0

Detailed Description

NGUI controls for NGUIDialogueUI's alert message.

Member Function Documentation

FadeOut()

IEnumerator PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.FadeOut

(

Action

FadedOutHandler

)

Fades out the alert line.

Returns

IEnumerator (coroutine).

Parameters

FadedOutHandler

Handler to call when finished fading out.

SetActive()

override void PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.SetActive ( bool  value )

virtual

Sets the alert controls active.

Parameters

value

true for active.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

SetMessage()

override void PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.SetMessage ( string  message, float  duration  )

virtual

Sets the alert message and begins the fade in/out routine.

Parameters

message	Alert message.
duration	Duration to show message.

Implements PixelCrushers.DialogueSystem.AbstractUIAlertControls.

Member Data Documentation

continueButton

UIButton PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.continueButton

Optional continue button to close the alert immediately.

fadeOutDuration

float PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.fadeOutDuration = 1

The duration to fade out at the end of showing the alert.

line

UILabel PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.line

The label used to show the alert message text.

panel

UIPanel PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.panel

The panel containing the alert controls.

A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.

Property Documentation

IsVisible

override bool PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls.IsVisible

get

Is an alert currently showing?

true if showing; otherwise, false.

---

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

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/NGUI3 Integration/Assets/Dialogue System/Third Party Support/NGUI/Scripts/NGUI Dialogue UI/NGUI Dialogue Controls/NGUIAlertControls.cs