PixelCrushers.DialogueSystem.CanvasDialogueUI Class Referenceabstract

This abstract subclass of AbstractDialogueUI is used for dialogue UIs that use a UI Canvas. More...

Inheritance diagram for PixelCrushers.DialogueSystem.CanvasDialogueUI:
Collaboration diagram for PixelCrushers.DialogueSystem.CanvasDialogueUI:

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
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 inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
static Sprite GetValidPortraitSprite (string actorName, Sprite portraitSprite)
 Gets a valid portrait sprite.
 
static Texture2D GetValidPortraitTexture (string actorName, Texture2D portraitTexture)
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void SetSubtitle (Subtitle subtitle, bool value)
 Sets a subtitle's content and visibility.
 
- Properties inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
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 inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
EventHandler< SelectedResponseEventArgsSelectedResponseHandler
 Occurs when the player selects a response.
 
- Events inherited from PixelCrushers.DialogueSystem.IDialogueUI
EventHandler< SelectedResponseEventArgsSelectedResponseHandler
 Your implementation must define this event and make it public.
 

Detailed Description

This abstract subclass of AbstractDialogueUI is used for dialogue UIs that use a UI Canvas.

It allows the Dialogue System to identify that the dialogue UI requires a Canvas.


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