Inheritance diagram for PixelCrushers.DialogueSystem.StandardDialogueUI:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.StandardDialogueUI:

[legend]

Public Member Functions
override void	Awake ()
	Sets up the component. More...

virtual void	OnEnable ()

virtual void	OnDisable ()

void	OnSceneLoaded (UnityEngine.SceneManagement.Scene scene, UnityEngine.SceneManagement.LoadSceneMode mode)

override void	Open ()
	Opens the conversation GUI. More...

override void	Update ()
	Updates this instance by hiding the alert message when it's done. More...

override void	ShowAlert (string message, float duration)
	Shows an alert. More...

override void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle (NPC or PC) based on the character type. More...

override void	HideSubtitle (Subtitle subtitle)
	Hides the subtitle based on its character type (PC or NPC). More...

virtual float	GetTypewriterSpeed ()
	Returns the speed of the first typewriter effect found. More...

virtual void	SetTypewriterSpeed (float charactersPerSecond)
	Sets the speed of all typewriter effects. More...

virtual void	SetActorSubtitlePanelNumber (DialogueActor dialogueActor, SubtitlePanelNumber subtitlePanelNumber)
	Changes a dialogue actor's subtitle panel for the currently active conversation. More...

override void	ShowResponses (Subtitle subtitle, Response[] responses, float timeout)
	Shows the player responses menu. More...

override void	OnClick (object data)
	Handles response button clicks. More...

Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void	Start ()
	Starts this instance by hiding everything. More...

virtual void	Close ()
	Closes the conversation GUI. More...

virtual void	HideAlert ()
	Hides the alert if it's showing. More...

virtual void	ShowContinueButton (Subtitle subtitle)
	Shows the continue button. More...

virtual void	HideContinueButton (Subtitle subtitle)
	Hides the continue button. More...

virtual void	HideResponses ()
	Hides the player response menu. More...

virtual void	ShowQTEIndicator (int index)
	Shows a QTE indicator. More...

virtual void	HideQTEIndicator (int index)
	Hides a QTE indicator. More...

virtual void	OnContinue ()
	Handles the continue button being clicked. More...

virtual void	OnContinueAlert ()

virtual void	OnContinueConversation ()

virtual void	SetPCPortrait (Texture2D portraitTexture, string portraitName)
	Sets the PC portrait name and texture. More...

virtual void	SetActorPortraitTexture (string actorName, Texture2D portraitTexture)
	Sets the portrait texture for an actor. More...

Public Attributes
StandardUIAlertControls	alertUIElements

StandardUIDialogueControls	conversationUIElements

StandardUIQTEControls	QTEIndicatorElements

bool	addEventSystemIfNeeded = true

Properties
override AbstractUIRoot	uiRootControls `[get]`

override AbstractUIAlertControls	alertControls `[get]`

override AbstractDialogueUIControls	dialogueControls `[get]`

override AbstractUIQTEControls	qteControls `[get]`

Queue< QueuedUIAlert >	alertQueue `[get]`

Properties inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
abstract AbstractUIRoot	uiRootControls `[get]`
	Gets the user interface root. More...

abstract AbstractDialogueUIControls	dialogueControls `[get]`
	Gets the dialogue controls. More...

abstract AbstractUIQTEControls	qteControls `[get]`
	Gets the QTE (Quick Time Event) indicators. More...

abstract AbstractUIAlertControls	alertControls `[get]`
	Gets the alert message controls. More...

bool	isOpen `[get, set]`
	Gets or sets a value indicating whether the dialogue UI (conversation interface) is open. More...

virtual bool	AreNonDialogueControlsVisible `[get]`
	Gets a value indicating whether non-conversation controls (e.g., alert message or QTEs) are visible. More...

Additional Inherited Members
Static Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
static Texture2D	GetValidPortraitTexture (string actorName, Texture2D portraitTexture)
	Gets a valid portrait texture. More...

Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void	SetSubtitle (Subtitle subtitle, bool value)
	Sets a subtitle's content and visibility. More...

Events inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
EventHandler< SelectedResponseEventArgs >	SelectedResponseHandler
	Occurs when the player selects a response. More...

Events inherited from PixelCrushers.DialogueSystem.IDialogueUI
EventHandler< SelectedResponseEventArgs >	SelectedResponseHandler
	Your implementation must define this event and make it public. More...

Member Function Documentation

override void PixelCrushers.DialogueSystem.StandardDialogueUI.Awake ( )

virtual

Sets up the component.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

virtual float PixelCrushers.DialogueSystem.StandardDialogueUI.GetTypewriterSpeed ( )

virtual

Returns the speed of the first typewriter effect found.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.HideSubtitle ( Subtitle subtitle )

virtual

Hides the subtitle based on its character type (PC or NPC).

Parameters

subtitle Subtitle to hide.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.OnClick ( object data )

virtual

Handles response button clicks.

Parameters

data	The Response assigned to the button. This is passed back to the handler.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

virtual void PixelCrushers.DialogueSystem.StandardDialogueUI.OnDisable ( )

virtual

virtual void PixelCrushers.DialogueSystem.StandardDialogueUI.OnEnable ( )

virtual

void PixelCrushers.DialogueSystem.StandardDialogueUI.OnSceneLoaded	(	UnityEngine.SceneManagement.Scene	scene,
		UnityEngine.SceneManagement.LoadSceneMode	mode
	)

override void PixelCrushers.DialogueSystem.StandardDialogueUI.Open ( )

virtual

Opens the conversation GUI.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

virtual void PixelCrushers.DialogueSystem.StandardDialogueUI.SetActorSubtitlePanelNumber	(	DialogueActor	dialogueActor,
		SubtitlePanelNumber	subtitlePanelNumber
	)

virtual

Changes a dialogue actor's subtitle panel for the currently active conversation.

virtual void PixelCrushers.DialogueSystem.StandardDialogueUI.SetTypewriterSpeed ( float charactersPerSecond )

virtual

Sets the speed of all typewriter effects.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.ShowAlert	(	string	message,
		float	duration
	)

virtual

Shows an alert.

Parameters

message	Message to show.
duration	Duration in seconds.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.ShowResponses	(	Subtitle	subtitle,
		Response[]	responses,
		float	timeout
	)

virtual

Shows the player responses menu.

Parameters

subtitle	The last subtitle, shown as a reminder.
responses	Responses.
timeout	If not `0`, the duration in seconds that the player has to choose a response; otherwise the currently-focused response is auto-selected. If no response is focused (e.g., hovered over), the first response is auto-selected. If `0`, there is no timeout; the player can take as long as desired to choose a response.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.ShowSubtitle ( Subtitle subtitle )

virtual

Shows the subtitle (NPC or PC) based on the character type.

Parameters

subtitle Subtitle to show.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

override void PixelCrushers.DialogueSystem.StandardDialogueUI.Update ( )

virtual

Updates this instance by hiding the alert message when it's done.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

Member Data Documentation

bool PixelCrushers.DialogueSystem.StandardDialogueUI.addEventSystemIfNeeded = true

StandardUIAlertControls PixelCrushers.DialogueSystem.StandardDialogueUI.alertUIElements

StandardUIDialogueControls PixelCrushers.DialogueSystem.StandardDialogueUI.conversationUIElements

StandardUIQTEControls PixelCrushers.DialogueSystem.StandardDialogueUI.QTEIndicatorElements

Property Documentation

override AbstractUIAlertControls PixelCrushers.DialogueSystem.StandardDialogueUI.alertControls

get

Queue<QueuedUIAlert> PixelCrushers.DialogueSystem.StandardDialogueUI.alertQueue

getprotected

override AbstractDialogueUIControls PixelCrushers.DialogueSystem.StandardDialogueUI.dialogueControls

get

override AbstractUIQTEControls PixelCrushers.DialogueSystem.StandardDialogueUI.qteControls

get

override AbstractUIRoot PixelCrushers.DialogueSystem.StandardDialogueUI.uiRootControls

get

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

D:/Documents/Unity Projects/Dialogue System/Dev/Release2/Assets/Plugins/Pixel Crushers/Dialogue System/Scripts/UI Subsystem/Standard/Dialogue/StandardDialogueUI.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Member Function Documentation

Member Data Documentation

Property Documentation