This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class. More...
Additional Inherited Members | |
Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityUITypewriterEffect | |
override void | Awake () |
override void | Start () |
override void | OnEnable () |
override void | OnDisable () |
virtual void | Pause () |
Pauses the effect. | |
virtual void | Unpause () |
Unpauses the effect. | |
override void | StartTyping (string text, int fromIndex=0) |
override void | StopTyping () |
virtual void | PlayText (string text, int fromIndex=0) |
Play typewriter on text immediately. | |
virtual IEnumerator | Play (int fromIndex=0) |
Plays the typewriter effect. | |
override void | Stop () |
Stops the effect. | |
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 | 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.UnityUITypewriterEffect | |
AutoScrollSettings | autoScrollSettings = new AutoScrollSettings() |
Optional auto-scroll settings. | |
UnityEvent | onBegin = new UnityEvent() |
UnityEvent | onCharacter = new UnityEvent() |
UnityEvent | onEnd = new UnityEvent() |
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 Types inherited from PixelCrushers.DialogueSystem.UnityUITypewriterEffect | |
enum | TokenType { Character , BoldOpen , BoldClose , ItalicOpen , ItalicClose , ColorOpen , ColorClose , SizeOpen , SizeClose , Quad , Pause , InstantOpen , InstantClose } |
Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityUITypewriterEffect | |
void | RemoveIfDuplicate () |
virtual void | StartTypewriterCoroutine (int fromIndex) |
Token | GetNextToken (List< Token > tokens) |
void | OpenRichText (StringBuilder current, Token token, List< TokenType > openTokens) |
void | CloseRichText (StringBuilder current, Token token, List< TokenType > openTokens) |
void | AddInstantText (StringBuilder current, List< TokenType > openTokenTypes, List< Token > tokens) |
string | GetCurrentText (StringBuilder current, List< TokenType > openTokenTypes, List< Token > tokens, bool withoutTransparentText=false) |
List< Token > | Tokenize (string text) |
Token | TryTokenize (string code, TokenType tokenType, float duration, ref string remainder) |
Token | TryTokenizeColorOpen (ref string remainder) |
Token | TryTokenizeSizeOpen (ref string remainder) |
Token | TryTokenizeQuad (ref string remainder) |
virtual void | StopTypewriterCoroutine () |
void | InitAutoScroll () |
void | HandleAutoScroll (bool jumpToEnd) |
IEnumerator | HandleAutoScrollAfterOneFrame (bool jumpToEnd) |
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.UnityUITypewriterEffect | |
UnityEngine.UI.Text | control |
bool | started = false |
string | original = null |
string | frontSkippedText = string.Empty |
Coroutine | typewriterCoroutine = null |
MonoBehaviour | coroutineController = null |
StringBuilder | current |
List< TokenType > | openTokenTypes |
List< Token > | tokens |
int | MaxSafeguard = 16384 |
Protected Attributes inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect | |
bool | paused = false |
Static Protected Attributes inherited from PixelCrushers.DialogueSystem.UnityUITypewriterEffect | |
const string | RichTextBoldOpen = "<b>" |
const string | RichTextBoldClose = "</b>" |
const string | RichTextItalicOpen = "<i>" |
const string | RichTextItalicClose = "</i>" |
const string | RichTextColorOpenPrefix = "<color=" |
const string | RichTextColorClose = "</color>" |
const string | RichTextSizeOpenPrefix = "<size=" |
const string | RichTextSizeClose = "</size>" |
const string | QuadPrefix = "<quad " |
Properties inherited from PixelCrushers.DialogueSystem.UnityUITypewriterEffect | |
override bool | isPlaying [get] |
Indicates whether the effect is playing. | |
Properties inherited from PixelCrushers.DialogueSystem.AbstractTypewriterEffect | |
bool | isPlaying [get] |
This wrapper class keeps references intact if you switch between the compiled assembly and source code versions of the original class.