Subtitle Unity UI controls for UnityUIDialogueUI. More...
Public Member Functions | |
void | CheckSubtitlePortrait (CharacterType characterType) |
override void | SetActive (bool value) |
void | ForceHide () |
void | ForceShow () |
void | ActivateUIElements () |
void | DeactivateUIElements () |
override void | ShowContinueButton () |
Shows the continue button. | |
override void | HideContinueButton () |
Hides the continue button. | |
override void | SetSubtitle (Subtitle subtitle) |
Sets the subtitle. | |
override void | ClearSubtitle () |
Clears the subtitle. | |
override void | SetActorPortraitSprite (string actorName, Sprite portraitSprite) |
Sets the portrait sprite to use in the subtitle if the named actor is the speaker. | |
void | AutoFocus (bool allowStealFocus=true) |
Auto-focuses the continue button. | |
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls | |
void | SetSubtitle (Subtitle subtitle) |
Sets the subtitle controls' contents. | |
void | ClearSubtitle () |
Clears the subtitle controls' contents. | |
virtual void | ShowSubtitle (Subtitle subtitle) |
Shows the subtitle controls. | |
virtual void | SetActorPortraitTexture (string actorName, Texture2D texture) |
Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractUIControls | |
void | SetActive (bool value) |
Sets the controls active/inactive. | |
void | Show () |
Shows the controls by setting them active. | |
void | Hide () |
Hides the controls by setting them inactive. | |
Public Attributes | |
UnityEngine.UI.Graphic | panel |
The panel containing the response menu controls. | |
UnityEngine.UI.Text | line |
The label that will show the text of the subtitle. | |
UnityEngine.UI.Image | portraitImage |
The label that will show the portrait image. | |
UnityEngine.UI.Text | portraitName |
The label that will show the name of the speaker. | |
UnityEngine.UI.Button | continueButton |
The continue button. | |
bool | ignorePauseCodes = false |
UIAnimationTransitions | animationTransitions = new UIAnimationTransitions() |
UIVisibility | uiVisibility = UIVisibility.OnlyDuringContent |
Properties | |
bool | isVisible [get] |
override bool | hasText [get] |
Indicates whether this subtitle is currently assigned text. | |
Properties inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls | |
bool | hasText [get] |
Gets a value indicating whether text has been assigned to the subtitle controls. | |
Additional Inherited Members | |
Protected Attributes inherited from PixelCrushers.DialogueSystem.AbstractUISubtitleControls | |
Subtitle | currentSubtitle = null |
Subtitle Unity UI controls for UnityUIDialogueUI.
|
inline |
|
inline |
Auto-focuses the continue button.
Useful for gamepads.
|
inline |
|
inline |
Clears the subtitle.
|
inline |
|
inline |
|
inline |
|
inlinevirtual |
Hides the continue button.
Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.
|
inline |
|
inlinevirtual |
Sets the portrait sprite to use in the subtitle if the named actor is the speaker.
This is used to immediately update the GUI control if the SetPortrait() sequencer command changes the portrait sprite.
actorName | Actor name in database. |
portraitSprite | Portrait sprite. |
Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.
|
inline |
Sets the subtitle.
subtitle | Subtitle. |
|
inlinevirtual |
Shows the continue button.
Reimplemented from PixelCrushers.DialogueSystem.AbstractUISubtitleControls.
UIAnimationTransitions PixelCrushers.DialogueSystem.UnityUISubtitleControls.animationTransitions = new UIAnimationTransitions() |
UnityEngine.UI.Button PixelCrushers.DialogueSystem.UnityUISubtitleControls.continueButton |
The continue button.
This is only required if DisplaySettings.waitForContinueButton is true
– in which case this button should send "OnContinue" to the UI when clicked.
bool PixelCrushers.DialogueSystem.UnityUISubtitleControls.ignorePauseCodes = false |
UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUISubtitleControls.line |
The label that will show the text of the subtitle.
UnityEngine.UI.Graphic PixelCrushers.DialogueSystem.UnityUISubtitleControls.panel |
The panel containing the response menu controls.
A panel is optional, but you may want one so you can include a background image, panel-wide effects, etc.
UnityEngine.UI.Image PixelCrushers.DialogueSystem.UnityUISubtitleControls.portraitImage |
The label that will show the portrait image.
UnityEngine.UI.Text PixelCrushers.DialogueSystem.UnityUISubtitleControls.portraitName |
The label that will show the name of the speaker.
UIVisibility PixelCrushers.DialogueSystem.UnityUISubtitleControls.uiVisibility = UIVisibility.OnlyDuringContent |
|
get |
Indicates whether this subtitle is currently assigned text.
true
if it has text; otherwise, false
.
|
get |