PausableTypewriter(TextMeshProUGUI,float,Action,Action,Action,Stack<(int position, float duration)>,CoroutineInterruptToken)
Method in Effects
Summary
A coroutine that gradually reveals the text in a TMPro.TextMeshProUGUI
object over time.
Remarks
Essentially identical to Typewriter(TextMeshProUGUI,float,Action,CoroutineInterruptToken) but supports pausing the animation based on pausePositions
values.
This method works by adjusting the value of the text
parameter's TextMeshProUGUI.maxVisibleCharacters
property. This means that word wrapping will not change half-way through the presentation of a word.
Depending on the value of lettersPerSecond
, onCharacterTyped
may be called multiple times per frame.
Due to an internal implementation detail of TextMeshProUGUI, this method will always take at least one frame to execute, regardless of the length of the text
parameter's text.
Parameters
TMPro.TextMeshProUGUI
text
A TextMeshProUGUI object to reveal the text of
float
lettersPerSecond
The number of letters that should be revealed per second.
System.Action
onCharacterTyped
An System.Action
that should be called for each character that was revealed.
System.Action
onPauseStarted
An System.Action
that will be called when the typewriter effect is paused.
System.Action
onPauseEnded
An System.Action
that will be called when the typewriter effect is restarted.
System.Collections.Generic.Stack<(int position, float duration)>
pausePositions
Last updated