This component implements IDialogueUI using Tasharen Entertainment's NGUI. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI:

[legend]

Collaboration diagram for PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI:

[legend]

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

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

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

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

override void	ShowSubtitle (Subtitle subtitle)
	Shows the subtitle (NPC or PC) based on the character type. 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	Update ()
	Updates this instance by hiding the alert message when it's done. More...

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

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

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

virtual void	ShowResponses (Subtitle subtitle, Response[] responses, float timeout)
	Shows the player responses menu. 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	OnClick (object data)
	Handles response button clicks. 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
UIRoot	uiRoot
	The UI root. More...

NGUIDialogueControls	dialogue
	The dialogue controls used in conversations. More...

UIPanel[]	qteIndicators
	QTE (Quick Time Event) indicators. More...

NGUIAlertControls	alert
	The alert message controls. More...

bool	deactivateUIRootWhenHidden = true

Properties
override AbstractUIRoot	UIRoot `[get]`

override AbstractDialogueUIControls	Dialogue `[get]`

override AbstractUIQTEControls	QTEs `[get]`

override AbstractUIAlertControls	Alert `[get]`

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

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

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

abstract AbstractUIAlertControls	Alert `[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...

Detailed Description

This component implements IDialogueUI using Tasharen Entertainment's NGUI.

It's based on AbstractDialogueUI and compiles the NGUI versions of the controls defined in NGUISubtitleControls, NGUIResponseMenuControls, NGUIAlertControls, etc.

To use this component, build an NGUI layout (or use a pre-built one in the Prefabs folder) and assign the UI control properties. You can save an NGUIDialogueUI as a prefab and assign the prefab or an instance to the DialogueManager.

The required controls are:

UIRoot
NPC subtitle line
PC subtitle line
Response menu buttons

The other control properties are optional. This component will activate and deactivate controls as they are needed in the conversation. You can add NGUI decorator scripts to the controls. If they trigger on enable, they'll play each time the control is shown.

Member Function Documentation

◆ Awake()

override void PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.Awake ( )

virtual

Sets up the component.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

◆ OnContinue()

override void PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.OnContinue ( )

virtual

Handles the continue button being clicked.

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

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

◆ Open()

override void PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.Open ( )

virtual

Opens the conversation GUI.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

◆ ShowAlert()

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

virtual

Shows an alert.

Parameters

message	Message to show.
duration	Duration in seconds.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

◆ ShowSubtitle()

override void PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.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.

Member Data Documentation

◆ alert

NGUIAlertControls PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.alert

The alert message controls.

◆ deactivateUIRootWhenHidden

bool PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.deactivateUIRootWhenHidden = true

◆ dialogue

NGUIDialogueControls PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.dialogue

The dialogue controls used in conversations.

◆ qteIndicators

UIPanel [] PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.qteIndicators

QTE (Quick Time Event) indicators.

◆ uiRoot

UIRoot PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.uiRoot

The UI root.

Property Documentation

◆ Alert

override AbstractUIAlertControls PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.Alert

get

◆ Dialogue

override AbstractDialogueUIControls PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.Dialogue

get

◆ QTEs

override AbstractUIQTEControls PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.QTEs

get

◆ UIRoot

override AbstractUIRoot PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI.UIRoot

get

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

D:/Documents/Unity Projects/Dialogue System/Dev/Integration/NGUI3 Integration/Assets/Dialogue System/Third Party Support/NGUI/Scripts/NGUI Dialogue UI/NGUIDialogueUI.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Awake()

◆ OnContinue()

◆ Open()

◆ ShowAlert()

◆ ShowSubtitle()

Member Data Documentation

◆ alert

◆ deactivateUIRootWhenHidden

◆ dialogue

◆ qteIndicators

◆ uiRoot

Property Documentation

◆ Alert

◆ Dialogue

◆ QTEs

◆ UIRoot