GUI controls for UnityDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls:

[legend]

Public Member Functions
override void	SetActive (bool value)
	Sets the controls active/inactive. More...

override void	SetMessage (string message, float duration)
	Sets the message text of an alert. 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
GUIControl	panel
	The alert panel. More...

GUILabel	line
	The label used to show the alert message text. More...

GUIButton	continueButton
	Optional continue button to close the alert immediately. 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

GUI controls for UnityDialogueUI's alert message.

Member Function Documentation

◆ SetActive()

override void PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls.SetActive ( bool value )

virtual

Sets the controls active/inactive.

Parameters

value true for active, false for inactive.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetMessage()

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

virtual

Sets the message text of an alert.

Parameters

message	Message.
duration	Duration that message will be shown. Used by subclasses to set up fade durations.

Implements PixelCrushers.DialogueSystem.AbstractUIAlertControls.

Member Data Documentation

◆ continueButton

GUIButton PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls.continueButton

Optional continue button to close the alert immediately.

◆ line

GUILabel PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls.line

The label used to show the alert message text.

◆ panel

GUIControl PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls.panel

The alert panel.

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.UnityGUI.UnityAlertControls.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/Source/Assets/Dialogue System/Scripts/Supplemental/Unity GUI/Unity Dialogue UI/Dialogue GUI Controls/UnityAlertControls.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members