PresentCharacter(int,TMP_Text,CancellationToken)

Method in TemporalMarkupHandler

Summary

Called repeatedly for each visible character in the line.

public abstract YarnTask PresentCharacter(int currentCharacterIndex, TMP_Text text, CancellationToken cancellationToken);

Remarks

This method is a TemporalMarkupHandler object's main opportunity to take action during line display.

Parameters

Name
Description

int currentCharacterIndex

The zero-based index of the character being displayed.

TMPro.TMP_Text text

A TMPro.TMP_Text object that the line is being displayed in.

System.Threading.CancellationToken cancellationToken

A cancellation token representing whether the

Returns

A task that completes when the TemporalMarkupHandler has completed presenting this character. Dialogue views will wait until this task is complete before displaying the remainder of the line.

Last updated

Yarn Spinnerยฎ and Secret Labยฎ are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.