PixelCrushers.DialogueSystem.AbstractUIAlertControls Class Referenceabstract

Abstract alert message controls. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractUIAlertControls:
Collaboration diagram for PixelCrushers.DialogueSystem.AbstractUIAlertControls:

Public Member Functions

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.
 

Protected Attributes

float m_alertDoneTime = 0
 

Properties

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?
 

Detailed Description

Abstract alert message controls.

Each GUI system implementation derives its own subclass from this.

Member Function Documentation

◆ SetMessage()

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

Sets the message text of an alert.

Parameters
messageMessage.
durationDuration that message will be shown. Used by subclasses to set up fade durations.

◆ ShowMessage()

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

Sets the GUI controls and shows a message.

Parameters
messageMessage to show.
durationDuration in seconds.

Member Data Documentation

◆ m_alertDoneTime

float PixelCrushers.DialogueSystem.AbstractUIAlertControls.m_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

bool PixelCrushers.DialogueSystem.AbstractUIAlertControls.isVisible
getabstract

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: