Controls for UnityUIDialogueUI's alert message.
More...
|
override void | SetActive (bool value) |
| Sets the alert controls active.
|
|
void | ActivateUIElements () |
|
void | DeactivateUIElements () |
|
override void | SetMessage (string message, float duration) |
| Sets the alert message UI Text.
|
|
void | AutoFocus (bool allowStealFocus=true) |
| Auto-focuses the continue button.
|
|
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.
|
|
|
override bool | isVisible [get] |
| Is an alert currently showing?
|
|
bool | IsHiding [get] |
|
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?
|
|
Controls for UnityUIDialogueUI's alert message.
◆ ActivateUIElements()
void PixelCrushers.DialogueSystem.UnityUIAlertControls.ActivateUIElements |
( |
| ) |
|
|
inline |
◆ AutoFocus()
void PixelCrushers.DialogueSystem.UnityUIAlertControls.AutoFocus |
( |
bool |
allowStealFocus = true | ) |
|
|
inline |
Auto-focuses the continue button.
Useful for gamepads.
◆ DeactivateUIElements()
void PixelCrushers.DialogueSystem.UnityUIAlertControls.DeactivateUIElements |
( |
| ) |
|
|
inline |
◆ SetActive()
override void PixelCrushers.DialogueSystem.UnityUIAlertControls.SetActive |
( |
bool |
value | ) |
|
|
inline |
Sets the alert controls active.
If a hide animation is available, this method depends on the hide animation to hide the controls.
- Parameters
-
◆ SetMessage()
override void PixelCrushers.DialogueSystem.UnityUIAlertControls.SetMessage |
( |
string |
message, |
|
|
float |
duration |
|
) |
| |
|
inline |
Sets the alert message UI Text.
- Parameters
-
message | Alert message. |
duration | Duration to show message. |
◆ animationTransitions
◆ continueButton
UnityEngine.UI.Button PixelCrushers.DialogueSystem.UnityUIAlertControls.continueButton |
Optional continue button to close the alert immediately.
◆ line
UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUIAlertControls.line |
The label used to show the alert message text.
◆ panel
UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUIAlertControls.panel |
The panel containing the alert controls.
A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.
◆ queueAlerts
bool PixelCrushers.DialogueSystem.UnityUIAlertControls.queueAlerts = false |
◆ waitForHideAnimation
bool PixelCrushers.DialogueSystem.UnityUIAlertControls.waitForHideAnimation = false |
◆ IsHiding
bool PixelCrushers.DialogueSystem.UnityUIAlertControls.IsHiding |
|
get |
◆ isVisible
override bool PixelCrushers.DialogueSystem.UnityUIAlertControls.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/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI/Unity UI/Dialogue/UnityUIAlertControls.cs