PixelCrushers.DialogueSystem.NGUI.DualSubtitleNGUIDialogueUI Class Reference

This class is an example of overriding NGUIDialogueUI to modify its behavior. More...

Inheritance diagram for PixelCrushers.DialogueSystem.NGUI.DualSubtitleNGUIDialogueUI:
Collaboration diagram for PixelCrushers.DialogueSystem.NGUI.DualSubtitleNGUIDialogueUI:

Public Member Functions

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...
 
override void ShowResponses (Subtitle subtitle, Response[] responses, float timeout)
 Shows the player responses menu. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI
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 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 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...
 

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...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI
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
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void SetSubtitle (Subtitle subtitle, bool value)
 Sets a subtitle's content and visibility. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.NGUI.NGUIDialogueUI
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...
 
- Events inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
EventHandler< SelectedResponseEventArgsSelectedResponseHandler
 Occurs when the player selects a response. More...
 
- Events inherited from PixelCrushers.DialogueSystem.IDialogueUI
EventHandler< SelectedResponseEventArgsSelectedResponseHandler
 Your implementation must define this event and make it public. More...
 

Detailed Description

This class is an example of overriding NGUIDialogueUI to modify its behavior.

It allows dual subtitles.

Member Function Documentation

◆ HideSubtitle()

override void PixelCrushers.DialogueSystem.NGUI.DualSubtitleNGUIDialogueUI.HideSubtitle ( Subtitle  subtitle)
virtual

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

Parameters
subtitleSubtitle to hide.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.

◆ ShowResponses()

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

Shows the player responses menu.

Parameters
subtitleThe last subtitle, shown as a reminder.
responsesResponses.
timeoutIf 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.

◆ ShowSubtitle()

override void PixelCrushers.DialogueSystem.NGUI.DualSubtitleNGUIDialogueUI.ShowSubtitle ( Subtitle  subtitle)
virtual

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

Parameters
subtitleSubtitle to show.

Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.


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