PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls Class Reference

Daikon Forge GUI controls for DaikonForgeDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls:
Collaboration diagram for PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls:

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

dfPanel panel
 The panel containing the controls. More...
 
dfLabel line
 The label used to show the alert message text. More...
 
dfButton continueButton
 Optional continue button to close the alert immediately. More...
 
float fadeInDuration = 0.5f
 
float fadeOutDuration = 0.5f
 

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

Daikon Forge GUI controls for DaikonForgeDialogueUI's alert message.

Member Function Documentation

◆ SetActive()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.SetActive ( bool  value)
virtual

Sets the alert controls active.

Parameters
valuetrue for active.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetMessage()

override void PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.SetMessage ( string  message,
float  duration 
)
virtual

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

Parameters
messageAlert message.
durationDuration to show message.

Implements PixelCrushers.DialogueSystem.AbstractUIAlertControls.

Member Data Documentation

◆ continueButton

dfButton PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.continueButton

Optional continue button to close the alert immediately.

◆ fadeInDuration

float PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.fadeInDuration = 0.5f

◆ fadeOutDuration

float PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.fadeOutDuration = 0.5f

◆ line

dfLabel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.line

The label used to show the alert message text.

◆ panel

dfPanel PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.panel

The panel containing the controls.

A panel is optional, but you may want one so you can include additional controls.

Property Documentation

◆ IsVisible

override bool PixelCrushers.DialogueSystem.DaikonForgeGUI.DaikonForgeAlertControls.IsVisible
get

Is an alert currently showing?

true if showing; otherwise, false.


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