PixelCrushers.DialogueSystem.StandardUIAlertControls Class Reference

Controls for StandardDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.StandardUIAlertControls:

Collaboration diagram for PixelCrushers.DialogueSystem.StandardUIAlertControls:

Public Member Functions
override void	SetActive (bool value)
	Sets the alert controls active.
void	HideImmediate ()
	Hide without playing animation.
override void	SetMessage (string message, float duration)
	Sets the alert message UI Text.
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIAlertControls
void	SetMessage (string message, float duration)
	Sets the message text of an alert.
virtual void	ShowMessage (string message, float duration)
	Sets the GUI controls and shows a message.
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
void	SetActive (bool value)
	Sets the controls active/inactive.
void	Show ()
	Shows the controls by setting them active.
void	Hide ()
	Hides the controls by setting them inactive.

Public Attributes
UIPanel	panel
UITextField	alertText
bool	queueAlerts = false
bool	dontQueueDuplicates = false
bool	waitForHideAnimation = false
bool	allowForceImmediate = false

Properties
override bool	isVisible [get]
	Is an alert currently showing?
bool	isHiding [get]
	Is the panel currently playing the Hide animation?
Properties inherited from PixelCrushers.DialogueSystem.AbstractUIAlertControls
bool	isVisible [get]
	Gets a value indicating whether an alert is visible.
virtual bool	isDone [get]
	Has the duration passed for the currently-showing alert?

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

Detailed Description

Controls for StandardDialogueUI's alert message.

Member Function Documentation

HideImmediate()

void PixelCrushers.DialogueSystem.StandardUIAlertControls.HideImmediate ( )

inline

Hide without playing animation.

SetActive()

override void PixelCrushers.DialogueSystem.StandardUIAlertControls.SetActive ( bool  value )

inline

Sets the alert controls active.

SetMessage()

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

inline

Sets the alert message UI Text.

Parameters

message	Alert message.
duration	Duration to show message.

Member Data Documentation

alertText

UITextField PixelCrushers.DialogueSystem.StandardUIAlertControls.alertText

allowForceImmediate

bool PixelCrushers.DialogueSystem.StandardUIAlertControls.allowForceImmediate = false

dontQueueDuplicates

bool PixelCrushers.DialogueSystem.StandardUIAlertControls.dontQueueDuplicates = false

panel

UIPanel PixelCrushers.DialogueSystem.StandardUIAlertControls.panel

queueAlerts

bool PixelCrushers.DialogueSystem.StandardUIAlertControls.queueAlerts = false

waitForHideAnimation

bool PixelCrushers.DialogueSystem.StandardUIAlertControls.waitForHideAnimation = false

Property Documentation

isHiding

bool PixelCrushers.DialogueSystem.StandardUIAlertControls.isHiding

get

Is the panel currently playing the Hide animation?

isVisible

override bool PixelCrushers.DialogueSystem.StandardUIAlertControls.isVisible

get

Is an alert currently showing?

---

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

• C:/Dev/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Standard/Dialogue/StandardUIAlertControls.cs