PixelCrushers.DialogueSystem.Wrappers.StandardDialogueUI Class Reference

This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class. More...

Inheritance diagram for PixelCrushers.DialogueSystem.Wrappers.StandardDialogueUI:
Collaboration diagram for PixelCrushers.DialogueSystem.Wrappers.StandardDialogueUI:

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
override void Awake ()
 Sets up the component.
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
void OnSceneLoaded (UnityEngine.SceneManagement.Scene scene, UnityEngine.SceneManagement.LoadSceneMode mode)
 
override void Open ()
 Opens the conversation GUI.
 
override void Close ()
 Closes the conversation GUI.
 
virtual bool AreAnyPanelsClosing (StandardUISubtitlePanel extraSubtitlePanel=null)
 
override void Update ()
 Updates this instance by hiding the alert message when it's done.
 
override void ShowAlert (string message, float duration)
 Shows an alert.
 
override void HideAllAlerts ()
 Hides the alert if it's showing.
 
override void ShowSubtitle (Subtitle subtitle)
 Shows the subtitle (NPC or PC) based on the character type.
 
override void HideSubtitle (Subtitle subtitle)
 Hides the subtitle based on its character type (PC or NPC).
 
virtual float GetTypewriterSpeed ()
 Returns the speed of the first typewriter effect found.
 
virtual void SetTypewriterSpeed (float charactersPerSecond)
 Sets the speed of all typewriter effects.
 
virtual void SetActorSubtitlePanelNumber (DialogueActor dialogueActor, SubtitlePanelNumber subtitlePanelNumber)
 Changes a dialogue actor's subtitle panel for the currently active conversation.
 
virtual void SetActorMenuPanelNumber (DialogueActor dialogueActor, MenuPanelNumber menuPanelNumber)
 Changes a dialogue actor's menu panel for the currently active conversation.
 
virtual void OverrideActorPanel (Actor actor, SubtitlePanelNumber subtitlePanelNumber, bool immediate=false)
 
virtual void ForceOverrideSubtitlePanel (StandardUISubtitlePanel customPanel)
 
virtual void ShowActorInPanel (Actor actor, SubtitlePanelNumber subtitlePanelNumber, StandardUISubtitlePanel customPanel=null)
 Shows an actor immediately in a subtitle panel.
 
override void ShowResponses (Subtitle subtitle, Response[] responses, float timeout)
 Shows the player responses menu.
 
override void OnClick (object data)
 Handles response button clicks.
 
virtual void OverrideActorMenuPanel (Transform actorTransform, MenuPanelNumber menuPanelNumber, StandardUIMenuPanel customPanel)
 
virtual void OverrideActorMenuPanel (Actor actor, MenuPanelNumber menuPanelNumber, StandardUIMenuPanel customPanel)
 
virtual void ForceOverrideMenuPanel (StandardUIMenuPanel customPanel)
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void Start ()
 Starts this instance by hiding everything.
 
virtual void HideAlert ()
 Hides the alert if it's showing.
 
virtual void ShowContinueButton (Subtitle subtitle)
 Shows the continue button.
 
virtual void HideContinueButton (Subtitle subtitle)
 Hides the continue button.
 
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 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)
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
StandardUIAlertControls alertUIElements
 
StandardUIDialogueControls conversationUIElements
 
StandardUIQTEControls QTEIndicatorElements
 
bool addEventSystemIfNeeded = true
 
bool verifyPanelAssignments = true
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
virtual void CloseNow ()
 
IEnumerator CloseAfterPanelsAreClosed ()
 
virtual bool IsMainPanelClosed ()
 
virtual IEnumerator ShowSubtitleWhenMainPanelOpen (Subtitle subtitle)
 
virtual void ShowSubtitleImmediate (Subtitle subtitle)
 
virtual IEnumerator ShowResponsesWhenMainPanelOpen (Subtitle subtitle, Response[] responses, float timeout)
 
virtual void ShowResponsesImmediate (Subtitle subtitle, Response[] responses, float timeout)
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI
virtual void SetSubtitle (Subtitle subtitle, bool value)
 Sets a subtitle's content and visibility.
 
- Protected Attributes inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
Coroutine closeCoroutine = null
 
- Static Protected Attributes inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
const float WaitForOpenTimeoutDuration = 8f
 
- Properties inherited from PixelCrushers.DialogueSystem.StandardDialogueUI
override AbstractUIRoot uiRootControls [get]
 
override AbstractUIAlertControls alertControls [get]
 
override AbstractDialogueUIControls dialogueControls [get]
 
override AbstractUIQTEControls qteControls [get]
 
Queue< QueuedUIAlertalertQueue [get]
 
- 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 wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class.


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