LetterTypewriter
public class LetterTypewriter : IAsyncTypewriterInherits from System.Object
Implements Yarn.Unity.IAsyncTypewriter
#Properties
#ActionMarkupHandlers
public List<IActionMarkupHandler> ActionMarkupHandlers { get; set; }Type List
#CharactersPerSecond
public float CharactersPerSecond { get; set; }Type Single
#TextElement
TMP_Text to display the text in.public TMP_Text? TextElement { get; set; }Type Nullable
#Methods
#ContentDidDismiss()
public void ContentDidDismiss()#ContentWillDismiss()
public void ContentWillDismiss()#PrepareForContent(Markup.MarkupParseResult)
public void PrepareForContent(Markup.MarkupParseResult line)Parameters
- The content of the line or option that is about to be shown
#RunTypewriter(Markup.MarkupParseResult, CancellationToken)
public async YarnTask RunTypewriter(Markup.MarkupParseResult line, CancellationToken cancellationToken)Parameters
- The line to display.
cancellationTokenSystem.Threading.CancellationTokenA token that indicates that the typewriter effect should be cancelled.
Returns YarnTask: A task that completes when the typewriter effect has
finished.
This method is called when a dialogue presenter wants to deliver a line's text. The typewriter should present the text to the user; it may take as long as it needs to do so.
If cancellationToken's System.Threading.CancellationToken.IsCancellationRequested becomes true, the
typewriter effect should end early and present the entire contents
of line.
Generated from Yarn Spinner for Unity 3.3.