This component implements a subclass of UnityUIDialogueUI that sends alerts to RPG Kit's message system. More...
Public Member Functions | |
override void | Start () |
Starts this instance by hiding everything. More... | |
override void | Open () |
Opens the conversation GUI. More... | |
override void | Close () |
Closes the conversation GUI. More... | |
override void | ShowAlert (string message, float duration) |
Shows an alert using RPG Kit's MessageHandler. More... | |
Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityUIDialogueUI | |
override void | Awake () |
Sets up the component. More... | |
virtual void | OnEnable () |
virtual void | OnDisable () |
OverrideUnityUIDialogueControls | FindActorOverride (Transform actor) |
void | OnSceneLoaded (UnityEngine.SceneManagement.Scene scene, UnityEngine.SceneManagement.LoadSceneMode mode) |
override void | ShowSubtitle (Subtitle subtitle) |
Shows the subtitle (NPC or PC) based on the character type. More... | |
void | CheckSubtitleAutoFocus (Subtitle subtitle) |
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... | |
void | CheckResponseMenuAutoFocus () |
override void | HideResponses () |
Hides the player response menu. More... | |
void | ClearSelection () |
override void | Update () |
Updates this instance by hiding the alert message when it's done. More... | |
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI | |
virtual void | HideAlert () |
Hides the alert if it's showing. More... | |
virtual void | ShowContinueButton (Subtitle subtitle) |
Shows the continue button. More... | |
virtual void | HideContinueButton (Subtitle subtitle) |
Hides the continue button. 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 | OnContinue () |
Handles the continue button being clicked. 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 | |
Unitycoding.UIWidgets.UIWidget | dialogueUIWidget |
Public Attributes inherited from PixelCrushers.DialogueSystem.UnityUIDialogueUI | |
UnityUIRoot | unityUIRoot |
The UI root. More... | |
UnityUIDialogueControls | dialogue |
The dialogue controls used in conversations. More... | |
UnityEngine.UI.Graphic[] | qteIndicators |
QTE (Quick Time Event) indicators. More... | |
UnityUIAlertControls | alert |
The alert message controls. More... | |
bool | autoFocus = false |
Set true to always keep a control focused; useful for gamepads. More... | |
bool | allowStealFocus = false |
Allow the dialogue UI to steal focus if a non-dialogue UI panel has it. More... | |
float | autoFocusCheckFrequency = 0.5f |
If auto focusing, check on this frequency in seconds that the control is focused. More... | |
bool | findActorOverrides = true |
Set true to look for OverrideUnityUIDialogueControls on actors. More... | |
bool | addEventSystemIfNeeded = true |
Set true to add an EventSystem if one isn't in the scene. 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.UnityUIDialogueUI | |
void | SetIsShowingSubtitle (Subtitle subtitle, bool value) |
Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractDialogueUI | |
virtual void | SetSubtitle (Subtitle subtitle, bool value) |
Sets a subtitle's content and visibility. More... | |
Protected Attributes inherited from PixelCrushers.DialogueSystem.UnityUIDialogueUI | |
UnityUISubtitleControls | originalNPCSubtitle |
UnityUISubtitleControls | originalPCSubtitle |
UnityUIResponseMenuControls | originalResponseMenu |
int | alertQueueCount = 0 |
bool | alertIsVisible |
bool | alertIsHiding |
Properties inherited from PixelCrushers.DialogueSystem.UnityUIDialogueUI | |
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< 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... | |
This component implements a subclass of UnityUIDialogueUI that sends alerts to RPG Kit's message system.
Also opens the dialogue UI using UIWidget if present.
|
virtual |
Closes the conversation GUI.
Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.
|
virtual |
Opens the conversation GUI.
Reimplemented from PixelCrushers.DialogueSystem.UnityUIDialogueUI.
|
virtual |
Shows an alert using RPG Kit's MessageHandler.
message | Message to show. |
duration | Duration in seconds. |
Reimplemented from PixelCrushers.DialogueSystem.UnityUIDialogueUI.
|
virtual |
Starts this instance by hiding everything.
The only exception is if an alert message is already showing; it keeps this message visible.
Reimplemented from PixelCrushers.DialogueSystem.AbstractDialogueUI.
Unitycoding.UIWidgets.UIWidget PixelCrushers.DialogueSystem.RPGKit.RPGKitDialogueUI.dialogueUIWidget |