Public Member Functions | |
AbstractTypewriterEffect | GetTypewriter () |
Returns the typewriter effect on the subtitle text element, or null if there is none. | |
bool | HasTypewriter () |
Checks if the subtitle text element has a typewriter effect. | |
float | GetTypewriterSpeed () |
Returns the speed of the typewriter effect on the subtitle element if it has one. | |
void | SetTypewriterSpeed (float charactersPerSecond) |
Sets the speed of the typewriter effect on the subtitle element if it has one. | |
virtual void | OpenOnStartConversation (Sprite portraitSprite, string portraitName, DialogueActor dialogueActor) |
Shows the panel at the start of the conversation; called if it's configured to be visible at the start. | |
virtual void | OpenOnStartConversation (Texture2D portraitTexture, string portraitName, DialogueActor dialogueActor) |
virtual void | OnConversationStart (Transform actor) |
virtual void | ShowSubtitle (Subtitle subtitle) |
Shows a subtitle, playing the open and focus animations. | |
virtual void | HideSubtitle (Subtitle subtitle) |
Hides a subtitle, playing the unfocus and close animations. | |
virtual void | HideImmediate () |
Immediately hides the panel without playing any animations. | |
override void | Open () |
Opens the panel. | |
override void | Close () |
Closes the panel. | |
virtual void | Focus () |
Focuses the panel. | |
virtual void | Unfocus () |
Unfocuses the panel. | |
virtual void | ActivateUIElements () |
virtual void | DeactivateUIElements () |
virtual void | ClearText () |
virtual void | ShowContinueButton () |
virtual void | HideContinueButton () |
virtual void | FinishSubtitle () |
Finishes the subtitle without hiding the panel. | |
virtual void | Select (bool allowStealFocus=true) |
Selects the panel's continue button (i.e., navigates to it). | |
virtual void | OnContinue () |
The continue button should call this method to continue. | |
virtual void | SetContent (Subtitle subtitle) |
Sets the content of the panel. | |
virtual void | SetPortraitName (string actorName) |
virtual void | SetActorPortraitSprite (string actorName, Sprite portraitSprite) |
virtual void | SetPortraitImage (Sprite sprite) |
virtual void | CheckSubtitleAnimator (Subtitle subtitle) |
Public Member Functions inherited from PixelCrushers.UIPanel | |
void | RefreshSelectablesList () |
void | RefreshAfterOneFrame () |
void | TakeFocus () |
Move this panel to the top of the stack. | |
virtual void | SetOpen (bool value) |
virtual void | Toggle () |
virtual void | SetFocus (GameObject selectable) |
virtual void | CheckFocus () |
Public Attributes | |
RectTransform | panel |
UnityEngine.UI.Image | portraitImage |
UITextField | portraitName |
UITextField | subtitleText |
bool | addSpeakerName = false |
string | addSpeakerNameFormat = "{0}: {1}" |
bool | accumulateText = false |
int | maxLines = 100 |
bool | delayTypewriterUntilOpen = false |
UnityEngine.UI.Button | continueButton |
float | blockInputDuration = 0 |
UIVisibility | visibility = UIVisibility.OnlyDuringContent |
string | focusAnimationTrigger = string.Empty |
string | unfocusAnimationTrigger = string.Empty |
bool | onlyShowNPCPortraits = false |
bool | useAnimatedPortraits = false |
bool | usePortraitNativeSize = false |
bool | waitForOpen = false |
bool | waitForClose = false |
bool | clearTextOnClose = true |
bool | clearTextOnConversationStart = false |
UIScrollbarEnabler | scrollbarEnabler |
UnityEvent | onFocus = new UnityEvent() |
Invoked when the subtitle panel gains focus. | |
UnityEvent | onUnfocus = new UnityEvent() |
Invoked when the subtitle panel loses focus. | |
Transform | m_actorOverridingPanel = null |
Public Attributes inherited from PixelCrushers.UIPanel | |
GameObject | firstSelected |
float | focusCheckFrequency = 0.2f |
float | refreshSelectablesFrequency = 0 |
bool | selectPreviousOnDisable = true |
string | showAnimationTrigger = "Show" |
string | hideAnimationTrigger = "Hide" |
StartState | startState = StartState.GameObjectState |
bool | waitForShowAnimationToSetOpen = false |
UnityEvent | onOpen = new UnityEvent() |
UnityEvent | onClose = new UnityEvent() |
UnityEvent | onClosed = new UnityEvent() |
UnityEvent | onBackButtonDown = new UnityEvent() |
Protected Member Functions | |
virtual void | Awake () |
virtual void | ShowSubtitleNow (Subtitle subtitle) |
virtual IEnumerator | ShowSubtitleAfterClosing (Subtitle subtitle) |
virtual void | StopShowAfterClosingCoroutine () |
override void | OnHidden () |
IEnumerator | FocusWhenOpen () |
virtual void | FocusNow () |
virtual void | SetUIElementsActive (bool value) |
virtual IEnumerator | ShowContinueButtonAfterBlockDuration () |
virtual void | ShowContinueButtonNow () |
virtual IEnumerator | SetSubtitleTextContentAfterOpen (Subtitle subtitle) |
virtual void | SetSubtitleTextContent (Subtitle subtitle) |
virtual string | RemoveFirstLine (string previousText) |
int | NumCharOccurrences (char c, string s) |
Returns the number of times character c occurs in string s. | |
virtual IEnumerator | StartTypingWhenFocused (UITextField subtitleText, string text, int fromIndex) |
virtual void | SetFormattedText (UITextField textField, string previousText, Subtitle subtitle) |
virtual void | SetFormattedText (UITextField textField, string previousText, FormattedText formattedText) |
virtual void | CheckDialogueActorAnimator (DialogueActor dialogueActor) |
virtual IEnumerator | SetAnimatorAtEndOfFrame (RuntimeAnimatorController animatorController) |
Protected Member Functions inherited from PixelCrushers.UIPanel | |
virtual void | Start () |
void | PushToPanelStack () |
void | PopFromPanelStack () |
virtual void | OnEnable () |
virtual void | OnDisable () |
virtual void | OnVisible () |
virtual void | Update () |
GameObject | GetFirstInteractableButton () |
Protected Attributes | |
int | numAccumulatedLines = 0 |
int | frameLastSetContent = -1 |
bool | shouldShowContinueButton = false |
Coroutine | m_focusWhenOpenCoroutine = null |
Coroutine | m_showAfterClosingCoroutine = null |
Coroutine | m_setAnimatorCoroutine = null |
Protected Attributes inherited from PixelCrushers.UIPanel | |
bool | m_deactivateOnHidden = true |
GameObject | m_previousSelected = null |
GameObject | m_lastSelected = null |
List< GameObject > | selectables = new List<GameObject>() |
Static Protected Attributes | |
const float | WaitForCloseTimeoutDuration = 8f |
Static Protected Attributes inherited from PixelCrushers.UIPanel | |
static List< UIPanel > | panelStack = new List<UIPanel>() |
Properties | |
bool | hasFocus [get, set] |
bool | isFocusing [get, set] |
override bool | waitForShowAnimation [get] |
virtual Subtitle | currentSubtitle [get, protected set] |
string | portraitActorName [get, protected set] |
The database name of the actor whose display name appears in the Portrait Name field. | |
bool | haveSavedOriginalColor [get, set] |
Color | originalColor [get, set] |
string | accumulatedText [get, set] |
virtual Animator | animator [get, set] |
bool | isDefaultNPCPanel [get, set] |
bool | isDefaultPCPanel [get, set] |
int | panelNumber [get, set] |
Transform | actorOverridingPanel [get, set] |
int | lastActorID [get, set] |
StandardDialogueUI | dialogueUI [get, set] |
Properties inherited from PixelCrushers.UIPanel | |
bool | deactivateOnHidden [get, set] |
static UIPanel | topPanel [get] |
PanelState | panelState [get, set] |
virtual bool | waitForShowAnimation [get, set] |
bool | isOpen [get] |
UIAnimatorMonitor | animatorMonitor [get] |
UnityEngine.EventSystems.EventSystem | eventSystem [get, set] |
Properties inherited from PixelCrushers.IEventSystemUser |
Additional Inherited Members | |
Public Types inherited from PixelCrushers.UIPanel | |
enum | StartState { GameObjectState , Open , Closed } |
enum | PanelState { Uninitialized , Opening , Open , Closing , Closed } |
Static Public Attributes inherited from PixelCrushers.UIPanel | |
static bool | monitorSelection = true |
If false, turns off checking of current selection to make sure a valid selectable is selected. | |
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Closes the panel.
Reimplemented from PixelCrushers.UIPanel.
|
inlinevirtual |
|
inlinevirtual |
Finishes the subtitle without hiding the panel.
Called if the panel is configured to stay open. Hides the continue button and stops the typewriter effect.
|
inlinevirtual |
Focuses the panel.
|
inlineprotectedvirtual |
|
inlineprotected |
|
inline |
Returns the typewriter effect on the subtitle text element, or null if there is none.
|
inline |
Returns the speed of the typewriter effect on the subtitle element if it has one.
|
inline |
Checks if the subtitle text element has a typewriter effect.
|
inlinevirtual |
|
inlinevirtual |
Immediately hides the panel without playing any animations.
|
inlinevirtual |
Hides a subtitle, playing the unfocus and close animations.
|
inlineprotected |
Returns the number of times character c occurs in string s.
|
inlinevirtual |
The continue button should call this method to continue.
|
inlinevirtual |
|
inlineprotectedvirtual |
Reimplemented from PixelCrushers.UIPanel.
|
inlinevirtual |
Opens the panel.
Reimplemented from PixelCrushers.UIPanel.
|
inlinevirtual |
Shows the panel at the start of the conversation; called if it's configured to be visible at the start.
portraitSprite | The image of the first actor who will use this panel. |
portraitName | The name of the first actor who will use this panel. |
dialogueActor | The actor's DialogueActor component, or null if none. |
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
Selects the panel's continue button (i.e., navigates to it).
allowStealFocus | Select continue button even if another element is already selected. |
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
Sets the content of the panel.
Assumes the panel is already open.
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inline |
Sets the speed of the typewriter effect on the subtitle element if it has one.
|
inlineprotectedvirtual |
|
inlinevirtual |
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
Shows a subtitle, playing the open and focus animations.
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlineprotectedvirtual |
|
inlinevirtual |
Unfocuses the panel.
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.accumulateText = false |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.addSpeakerName = false |
string PixelCrushers.DialogueSystem.StandardUISubtitlePanel.addSpeakerNameFormat = "{0}: {1}" |
float PixelCrushers.DialogueSystem.StandardUISubtitlePanel.blockInputDuration = 0 |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.clearTextOnClose = true |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.clearTextOnConversationStart = false |
UnityEngine.UI.Button PixelCrushers.DialogueSystem.StandardUISubtitlePanel.continueButton |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.delayTypewriterUntilOpen = false |
string PixelCrushers.DialogueSystem.StandardUISubtitlePanel.focusAnimationTrigger = string.Empty |
|
protected |
Transform PixelCrushers.DialogueSystem.StandardUISubtitlePanel.m_actorOverridingPanel = null |
|
protected |
|
protected |
|
protected |
int PixelCrushers.DialogueSystem.StandardUISubtitlePanel.maxLines = 100 |
|
protected |
UnityEvent PixelCrushers.DialogueSystem.StandardUISubtitlePanel.onFocus = new UnityEvent() |
Invoked when the subtitle panel gains focus.
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.onlyShowNPCPortraits = false |
UnityEvent PixelCrushers.DialogueSystem.StandardUISubtitlePanel.onUnfocus = new UnityEvent() |
Invoked when the subtitle panel loses focus.
RectTransform PixelCrushers.DialogueSystem.StandardUISubtitlePanel.panel |
UnityEngine.UI.Image PixelCrushers.DialogueSystem.StandardUISubtitlePanel.portraitImage |
UITextField PixelCrushers.DialogueSystem.StandardUISubtitlePanel.portraitName |
UIScrollbarEnabler PixelCrushers.DialogueSystem.StandardUISubtitlePanel.scrollbarEnabler |
|
protected |
UITextField PixelCrushers.DialogueSystem.StandardUISubtitlePanel.subtitleText |
string PixelCrushers.DialogueSystem.StandardUISubtitlePanel.unfocusAnimationTrigger = string.Empty |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.useAnimatedPortraits = false |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.usePortraitNativeSize = false |
UIVisibility PixelCrushers.DialogueSystem.StandardUISubtitlePanel.visibility = UIVisibility.OnlyDuringContent |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.waitForClose = false |
|
staticprotected |
bool PixelCrushers.DialogueSystem.StandardUISubtitlePanel.waitForOpen = false |
|
getset |
|
getset |
|
getsetprotected |
|
getprotected set |
|
getset |
|
getset |
|
getsetprotected |
|
getset |
|
getset |
|
getset |
|
getsetprotected |
|
getsetprotected |
|
getset |
|
getprotected set |
The database name of the actor whose display name appears in the Portrait Name field.
|
get |