This abstract class forms the base for many IDialogueUI implementations. More...

Inheritance diagram for PixelCrushers.DialogueSystem.AbstractDialogueUI:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.AbstractDialogueUI:

[legend]

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

virtual void	Start ()
	Starts this instance by hiding everything.

virtual void	Open ()
	Opens the conversation GUI.

virtual void	Close ()
	Closes the conversation GUI.

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

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

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

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

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

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

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

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

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

virtual void	HideResponses ()
	Hides the player response menu.

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

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

virtual void	OnClick (object data)
	Handles response button clicks.

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

virtual void	OnContinueAlert ()

virtual void	OnContinueConversation ()

virtual void	SetPCPortrait (Sprite portraitSprite, string portraitName)
	Sets the PC portrait name and sprite.

virtual void	SetPCPortrait (Texture2D portraitTexture, string portraitName)

virtual void	SetActorPortraitSprite (string actorName, Sprite portraitSprite)
	Sets the portrait sprite for an actor.

Static Public Member Functions
static Sprite	GetValidPortraitSprite (string actorName, Sprite portraitSprite)
	Gets a valid portrait sprite.

static Texture2D	GetValidPortraitTexture (string actorName, Texture2D portraitTexture)

Protected Member Functions
virtual void	SetSubtitle (Subtitle subtitle, bool value)
	Sets a subtitle's content and visibility.

Properties
AbstractUIRoot	uiRootControls `[get]`
	Gets the user interface root.

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

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

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

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

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

Events
EventHandler< SelectedResponseEventArgs >	SelectedResponseHandler
	Occurs when the player selects a response.

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

Detailed Description

This abstract class forms the base for many IDialogueUI implementations.

It implements common code so that the specific implementation for each GUI system need only deal with the data structures specific to each GUI system.

Member Function Documentation

◆ Awake()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.Awake ( )

inlinevirtual

Sets up the component.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueUI, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueUI, PixelCrushers.DialogueSystem.UnityGUI.UnityDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, PixelCrushers.DialogueSystem.UnityUIBarkSubtitleDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ Close()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.Close ( )

inlinevirtual

Closes the conversation GUI.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.SMSDialogueUI, and PixelCrushers.DialogueSystem.StandardDialogueUI.

◆ GetValidPortraitSprite()

static Sprite PixelCrushers.DialogueSystem.AbstractDialogueUI.GetValidPortraitSprite	(	string	actorName,
		Sprite	portraitSprite
	)

inlinestatic

Gets a valid portrait sprite.

If the provided portraitSprite is null, grabs the default sprites from the database.

Returns: The valid portrait sprite.

Parameters

actorName	Actor name.
portraitSprite	Portrait sprite.

◆ GetValidPortraitTexture()

static Texture2D PixelCrushers.DialogueSystem.AbstractDialogueUI.GetValidPortraitTexture	(	string	actorName,
		Texture2D	portraitTexture
	)

inlinestatic

◆ HideAlert()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideAlert ( )

inlinevirtual

Hides the alert if it's showing.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

◆ HideAllAlerts()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideAllAlerts ( )

inlinevirtual

Hides the alert if it's showing.

Virtual so StandardDialogueUI can override to clear alert queue, too.

Reimplemented in PixelCrushers.DialogueSystem.StandardDialogueUI.

◆ HideContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideContinueButton ( Subtitle subtitle )

inlinevirtual

Hides the continue button.

Call this after showing the subtitle. The ConversationView uses this to hide the continue button if the display setting for continue buttons is set to NotBeforeResponseMenu.

Parameters

subtitle Subtitle.

◆ HideQTEIndicator()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideQTEIndicator ( int index )

inlinevirtual

Hides a QTE indicator.

Parameters

index Index of the QTE indicator.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

◆ HideResponses()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideResponses ( )

inlinevirtual

Hides the player response menu.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ HideSubtitle()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.HideSubtitle ( Subtitle subtitle )

inlinevirtual

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

Parameters

subtitle Subtitle to hide.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.SMSDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ OnClick()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.OnClick ( object data )

inlinevirtual

Handles response button clicks.

Parameters

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

Reimplemented in PixelCrushers.DialogueSystem.StandardDialogueUI.

◆ OnContinue()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.OnContinue ( )

inlinevirtual

Handles the continue button being clicked.

This sends OnConversationContinue to the DialogueManager object so the ConversationView knows to progress the conversation.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueUI.

◆ OnContinueAlert()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.OnContinueAlert ( )

inlinevirtual

◆ OnContinueConversation()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.OnContinueConversation ( )

inlinevirtual

Reimplemented in PixelCrushers.DialogueSystem.SMSDialogueUI.

◆ Open()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.Open ( )

inlinevirtual

Opens the conversation GUI.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueUI, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.UnityGUI.UnityDialogueUI, PixelCrushers.DialogueSystem.SMSDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ SetActorPortraitSprite()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.SetActorPortraitSprite	(	string	actorName,
		Sprite	portraitSprite
	)

inlinevirtual

Sets the portrait sprite for an actor.

This is used to immediately update the GUI control if the SetPortrait() sequencer command changes the portrait sprite.

Parameters

actorName	Actor name in database.
portraitSprite	Portrait sprite.

◆ SetPCPortrait() [1/2]

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.SetPCPortrait	(	Sprite	portraitSprite,
		string	portraitName
	)

inlinevirtual

Sets the PC portrait name and sprite.

Parameters

portraitSprite	Portrait sprite.
portraitName	Portrait name.

◆ SetPCPortrait() [2/2]

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.SetPCPortrait	(	Texture2D	portraitTexture,
		string	portraitName
	)

inlinevirtual

◆ SetSubtitle()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.SetSubtitle	(	Subtitle	subtitle,
		bool	value
	)

inlineprotectedvirtual

Sets a subtitle's content and visibility.

Parameters

subtitle	Subtitle. The speaker recorded in the subtitle determines whether the NPC or PC subtitle controls are used.
value	`true` to show; `false` to hide.

◆ ShowAlert()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.ShowAlert	(	string	message,
		float	duration
	)

inlinevirtual

Shows an alert.

Parameters

message	Message to show.
duration	Duration in seconds.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueUI, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ ShowContinueButton()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.ShowContinueButton ( Subtitle subtitle )

inlinevirtual

Shows the continue button.

Parameters

subtitle Subtitle.

Reimplemented in PixelCrushers.DialogueSystem.SMSDialogueUI.

◆ ShowQTEIndicator()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.ShowQTEIndicator ( int index )

inlinevirtual

Shows a QTE indicator.

Parameters

index Index of the QTE indicator.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

◆ ShowResponses()

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

inlinevirtual

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.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.SMSDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ ShowSubtitle()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.ShowSubtitle ( Subtitle subtitle )

inlinevirtual

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

Parameters

subtitle Subtitle to show.

Implements PixelCrushers.DialogueSystem.IDialogueUI.

Reimplemented in PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueBarkUI, PixelCrushers.DialogueSystem.NGUISupport.NGUIDialogueUI, PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.SMSDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, PixelCrushers.DialogueSystem.UnityUIBarkSubtitleDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

◆ Start()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.Start ( )

inlinevirtual

Starts this instance by hiding everything.

The only exception is if an alert message is already showing; it keeps this message visible.

Reimplemented in PixelCrushers.DialogueSystem.TK2DSupport.TK2DDialogueUI.

◆ Update()

virtual void PixelCrushers.DialogueSystem.AbstractDialogueUI.Update ( )

inlinevirtual

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

Reimplemented in PixelCrushers.DialogueSystem.TextMeshProSupport.TextMeshProDialogueUI, PixelCrushers.DialogueSystem.StandardDialogueUI, and PixelCrushers.DialogueSystem.UnityUIDialogueUI.

Property Documentation

◆ alertControls

AbstractUIAlertControls PixelCrushers.DialogueSystem.AbstractDialogueUI.alertControls

getabstract

Gets the alert message controls.

The alert message controls

◆ AreNonDialogueControlsVisible

virtual bool PixelCrushers.DialogueSystem.AbstractDialogueUI.AreNonDialogueControlsVisible

getprotected

Gets a value indicating whether non-conversation controls (e.g., alert message or QTEs) are visible.

true if non-conversation controls are visible; otherwise, false.

◆ dialogueControls

AbstractDialogueUIControls PixelCrushers.DialogueSystem.AbstractDialogueUI.dialogueControls

getabstract

Gets the dialogue controls.

The dialogue controls.

◆ isOpen

bool PixelCrushers.DialogueSystem.AbstractDialogueUI.isOpen

getset

Gets or sets a value indicating whether the dialogue UI (conversation interface) is open.

true if open; otherwise, false.

◆ qteControls

AbstractUIQTEControls PixelCrushers.DialogueSystem.AbstractDialogueUI.qteControls

getabstract

Gets the QTE (Quick Time Event) indicators.

The QTE indicators.

◆ uiRootControls

AbstractUIRoot PixelCrushers.DialogueSystem.AbstractDialogueUI.uiRootControls

getabstract

Gets the user interface root.

The user interface root.

Event Documentation

◆ SelectedResponseHandler

EventHandler<SelectedResponseEventArgs> PixelCrushers.DialogueSystem.AbstractDialogueUI.SelectedResponseHandler

Occurs when the player selects a response.

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/Abstract/Dialogue/AbstractDialogueUI.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ Awake()

◆ Close()

◆ GetValidPortraitSprite()

◆ GetValidPortraitTexture()

◆ HideAlert()

◆ HideAllAlerts()

◆ HideContinueButton()

◆ HideQTEIndicator()

◆ HideResponses()

◆ HideSubtitle()

◆ OnClick()

◆ OnContinue()

◆ OnContinueAlert()

◆ OnContinueConversation()

◆ Open()

◆ SetActorPortraitSprite()

◆ SetPCPortrait() [1/2]

◆ SetPCPortrait() [2/2]

◆ SetSubtitle()

◆ ShowAlert()

◆ ShowContinueButton()

◆ ShowQTEIndicator()

◆ ShowResponses()

◆ ShowSubtitle()

◆ Start()

◆ Update()

Property Documentation

◆ alertControls

◆ AreNonDialogueControlsVisible

◆ dialogueControls

◆ isOpen

◆ qteControls

◆ uiRootControls

Event Documentation

◆ SelectedResponseHandler