GUI controls for TK2DDialogueUI's alert message. More...

Inheritance diagram for PixelCrushers.DialogueSystem.TK2D.TK2DAlertControls:

Collaboration diagram for PixelCrushers.DialogueSystem.TK2D.TK2DAlertControls:

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 if a TK2DFader is attached. 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
tk2dUILayout	panel
	The alert panel. More...

tk2dTextMesh	line
	The text mesh used to show the alert message text. More...

tk2dUIItem	continueButton
	The continue button. More...

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

GUI controls for TK2DDialogueUI's alert message.

Member Function Documentation

◆ SetActive()

override void PixelCrushers.DialogueSystem.TK2D.TK2DAlertControls.SetActive ( bool value )

virtual

Sets the alert controls active.

Parameters

value true for active.

Implements PixelCrushers.DialogueSystem.AbstractUIControls.

◆ SetMessage()

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

virtual

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.

Implements PixelCrushers.DialogueSystem.AbstractUIAlertControls.

Member Data Documentation

◆ continueButton

tk2dUIItem PixelCrushers.DialogueSystem.TK2D.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.TK2D.TK2DAlertControls.line

The text mesh used to show the alert message text.

◆ panel

tk2dUILayout PixelCrushers.DialogueSystem.TK2D.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.

Property Documentation

◆ IsVisible

override bool PixelCrushers.DialogueSystem.TK2D.TK2DAlertControls.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/Integration/TK2D Integration/Assets/Dialogue System/Third Party Support/TK2D/TK2D Dialogue UI/TK2DAlertControls.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members