PixelCrushers.DialogueSystem.Wrappers.TextMeshProTypewriterEffect Class Reference
Inheritance diagram for PixelCrushers.DialogueSystem.Wrappers.TextMeshProTypewriterEffect:
Collaboration diagram for PixelCrushers.DialogueSystem.Wrappers.TextMeshProTypewriterEffect:

Additional Inherited Members

- Public Member Functions inherited from PixelCrushers.DialogueSystem.TextMeshProTypewriterEffect
override void Awake ()
 
override void Start ()
 
override void StartTyping (string text, int fromIndex=0)
 
override void Stop ()
 
override void StopTyping ()
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
virtual float GetSpeed ()
 Returns the typewriter's charactersPerSecond.
 
virtual void SetSpeed (float charactersPerSecond)
 Sets the typewriter's charactersPerSecond.
 
void Start ()
 
virtual void OnEnable ()
 
virtual void OnDisable ()
 
virtual void StopOnConversationEnd (Transform actor)
 
void Stop ()
 
void StartTyping (string text, int fromIndex=0)
 
void StopTyping ()
 
virtual void StopCharacterAudio ()
 
- Static Public Member Functions inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
static string StripRPGMakerCodes (string s)
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
bool rightToLeft = false
 Set true to type right to left.
 
float charactersPerSecond = 50
 How fast to "type.".
 
AudioClip audioClip = null
 The audio clip to play with each character.
 
AudioClip[] alternateAudioClips = new AudioClip[0]
 If specified, randomly use these clips or the main Audio Clip.
 
AudioSource audioSource = null
 The audio source through which to play the clip.
 
bool usePlayOneShot = false
 
bool interruptAudioClip = false
 If audio clip is still playing from previous character, stop and restart it when typing next character.
 
bool stopAudioOnSilentCharacters = false
 
bool stopAudioOnPauseCodes = false
 
string silentCharacters = string.Empty
 Don't play audio on these characters.
 
string fullPauseCharacters = string.Empty
 Play a full pause on these characters.
 
string quarterPauseCharacters = string.Empty
 Play a quarter pause on these characters.
 
float fullPauseDuration = 1f
 Duration to pause on when text contains '\.
 
float quarterPauseDuration = 0.25f
 Duration to pause when text contains '\,'.
 
bool removeDuplicateTypewriterEffects = true
 Ensures this GameObject has only one typewriter effect.
 
bool playOnEnable = true
 Play using the current text content whenever component is enabled.
 
bool waitOneFrameBeforeStarting = false
 Wait one frame to allow layout elements to setup first.
 
bool stopOnConversationEnd = false
 Stop typing when the conversation ends.
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
virtual void PreprocessPauseCharacters ()
 Process anything special in full/quarterPauseCharacters, such as
to newlines.
 
virtual bool IsFullPauseCharacter (char c)
 
virtual bool IsQuarterPauseCharacter (char c)
 
virtual bool IsSilentCharacter (char c)
 
bool IsCharacterInString (char c, string s)
 
virtual void PlayCharacterAudio (char c)
 
virtual void PlayCharacterAudio ()
 
virtual IEnumerator PauseForDuration (float duration)
 
- Protected Attributes inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
bool paused = false
 
- Properties inherited from PixelCrushers.DialogueSystem.TextMeshProTypewriterEffect
override bool isPlaying [get]
 
- Properties inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect
bool isPlaying [get]
 

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