Controls for UnityUIDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityUIAlertControls:

Collaboration diagram for PixelCrushers.DialogueSystem.UnityUIAlertControls:

[legend]

Public Member Functions
override void	SetActive (bool value)
	Sets the alert controls active. More...

void	ActivateUIElements ()

void	DeactivateUIElements ()

override void	SetMessage (string message, float duration)
	Sets the alert message UI Text. More...

void	AutoFocus (bool allowStealFocus=true)
	Auto-focuses the continue button. 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
UnityEngine.UI.Graphic	panel
	The panel containing the alert controls. More...

UnityEngine.UI.Text	line
	The label used to show the alert message text. More...

UnityEngine.UI.Button	continueButton
	Optional continue button to close the alert immediately. More...

bool	queueAlerts = false

bool	waitForHideAnimation = false

UIAnimationTransitions	animationTransitions = new UIAnimationTransitions()

Properties
override bool	IsVisible `[get]`
	Is an alert currently showing? More...

bool	IsHiding `[get]`

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

Controls for UnityUIDialogueUI's alert message.

Member Function Documentation

◆ ActivateUIElements()

void PixelCrushers.DialogueSystem.UnityUIAlertControls.ActivateUIElements ( )

◆ AutoFocus()

void PixelCrushers.DialogueSystem.UnityUIAlertControls.AutoFocus ( bool allowStealFocus = true )

Auto-focuses the continue button.

Useful for gamepads.

◆ DeactivateUIElements()

void PixelCrushers.DialogueSystem.UnityUIAlertControls.DeactivateUIElements ( )

◆ SetActive()

override void PixelCrushers.DialogueSystem.UnityUIAlertControls.SetActive ( bool value )

virtual

Sets the alert controls active.

If a hide animation is available, this method depends on the hide animation to hide the controls.

Parameters

value true for active.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetMessage()

override void PixelCrushers.DialogueSystem.UnityUIAlertControls.SetMessage	(	string	message,
		float	duration
	)

virtual

Sets the alert message UI Text.

Parameters

message	Alert message.
duration	Duration to show message.

Implements PixelCrushers.DialogueSystem.AbstractUIAlertControls.

Member Data Documentation

◆ animationTransitions

UIAnimationTransitions PixelCrushers.DialogueSystem.UnityUIAlertControls.animationTransitions = new UIAnimationTransitions()

◆ 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

Property Documentation

◆ 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:

D:/Documents/Unity Projects/Dialogue System/Dev/Release/Assets/Dialogue System/Scripts/Supplemental/UI/Dialogue UI/UnityUIAlertControls.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members