Abstract alert message controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUIAlertControls:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUIAlertControls:

Public Member Functions
abstract void	SetMessage (string message, float duration)
	Sets the message text of an alert. More...

virtual void	ShowMessage (string message, float duration)
	Sets the GUI controls and shows a message. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls
abstract void	SetActive (bool value)
	Sets the controls active/inactive. More...

void	Show ()
	Shows the controls by setting them active. More...

void	Hide ()
	Hides the controls by setting them inactive. More...

Protected Attributes
float	alertDoneTime = 0

Properties
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...

Detailed Description

Abstract alert message controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

◆ SetMessage()

abstract void PixelCrushers.DialogueSystem.AbstractUIAlertControls.SetMessage	(	string	message,
		float	duration
	)

pure 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.

Implemented in PixelCrushers.DialogueSystem.UnityUIAlertControls, PixelCrushers.DialogueSystem.TextMeshPro.TextMeshProAlertControls, PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls, PixelCrushers.DialogueSystem.TK2D.TK2DAlertControls, PixelCrushers.DialogueSystem.NGUI.NGUIAlertControls, and PixelCrushers.DialogueSystem.UnityGUI.UnityAlertControls.

◆ ShowMessage()

virtual void PixelCrushers.DialogueSystem.AbstractUIAlertControls.ShowMessage	(	string	message,
		float	duration
	)

virtual

Sets the GUI controls and shows a message.

Parameters

message	Message to show.
duration	Duration in seconds.

Member Data Documentation

◆ alertDoneTime

float PixelCrushers.DialogueSystem.AbstractUIAlertControls.alertDoneTime = 0

protected

Property Documentation

◆ IsDone

virtual bool PixelCrushers.DialogueSystem.AbstractUIAlertControls.IsDone

get

Has the duration passed for the currently-showing alert?

true if done; otherwise, false.

◆ IsVisible

abstract bool PixelCrushers.DialogueSystem.AbstractUIAlertControls.IsVisible

get

Gets a value indicating whether an alert is visible.

true if visible; 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/Abstract UI/Abstract Dialogue UI/AbstractUIAlertControls.cs

Public Member Functions

Protected Attributes

Properties