GUI controls for TK2DDialogueUI's alert message.
More...
|
override void | SetActive (bool value) |
| Sets the alert controls active.
|
|
override void | SetMessage (string message, float duration) |
| Sets the alert message and begins the fade in/out routine if a TK2DFader is attached.
|
|
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.
|
|
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.
|
|
|
tk2dUILayout | panel |
| The alert panel.
|
|
tk2dTextMesh | line |
| The text mesh used to show the alert message text.
|
|
tk2dUIItem | continueButton |
| The continue button.
|
|
|
override bool | isVisible [get] |
| Is an alert currently showing?
|
|
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?
|
|
GUI controls for TK2DDialogueUI's alert message.
◆ SetActive()
override void PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.SetActive |
( |
bool |
value | ) |
|
|
inline |
Sets the alert controls active.
- Parameters
-
◆ SetMessage()
override void PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.SetMessage |
( |
string |
message, |
|
|
float |
duration |
|
) |
| |
|
inline |
Sets the alert message and begins the fade in/out routine if a TK2DFader is attached.
- Parameters
-
message | Alert message. |
duration | Duration to show message. |
◆ continueButton
tk2dUIItem PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.continueButton |
The continue button.
This button is only required if DisplaySettings.waitForContinueButton is true
– in which case this button should send "OnContinue" to the UI when clicked.
◆ line
tk2dTextMesh PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.line |
The text mesh used to show the alert message text.
◆ panel
tk2dUILayout PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.panel |
The alert panel.
A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.
◆ isVisible
override bool PixelCrushers.DialogueSystem.TK2DSupport.TK2DAlertControls.isVisible |
|
get |
Is an alert currently showing?
true
if showing; otherwise, false
.
The documentation for this class was generated from the following file:
- C:/Dev/Dialogue System/Dev/Integration2/TK2D Integration/Assets/Pixel Crushers/Dialogue System/Third Party Support/TK2D Support/Scripts/TK2D Dialogue UI/TK2DAlertControls.cs