PixelCrushers.DialogueSystem.Wrappers.StandardUISubtitlePanel 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.StandardUISubtitlePanel:
Collaboration diagram for PixelCrushers.DialogueSystem.Wrappers.StandardUISubtitlePanel:

Additional Inherited Members

- Public Types inherited from PixelCrushers.UIPanel
enum  StartState { GameObjectState , Open , Closed }
 
enum  PanelState {
  Uninitialized , Opening , Open , Closing ,
  Closed
}
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
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 inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
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()
 
- 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.
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
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 inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
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 inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
const float WaitForCloseTimeoutDuration = 8f
 
- Static Protected Attributes inherited from PixelCrushers.UIPanel
static List< UIPanelpanelStack = new List<UIPanel>()
 
- Properties inherited from PixelCrushers.DialogueSystem.StandardUISubtitlePanel
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

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: