1 of 7

TypewriterHandler

Inherits from TemporalMarkupHandler

Summary

A TemporalMarkupHandler that progressively reveals the text of a line at a fixed rate of time.

public sealed class TypewriterHandler : TemporalMarkupHandler

Fields

Name

Description

The number of letters that will be shown per second.

An event that will be invoked for each

Methods

Name

Description

Stops the internal time counter, and finishes displaying the line.

Calculates the points in the typewriter should pause at, and starts the typewriter's internal time counter.

Resets the typewriter back to the initial state.

Presents a single character of the line, at the appropriate point in time.

lettersPerSecond

Field in TypewriterHandler

Summary

The number of letters that will be shown per second.

public int lettersPerSecond = 60;

onCharacterTyped

Field in TypewriterHandler

Summary

An event that will be invoked for each

public UnityEngine.Events.UnityEvent? onCharacterTyped;

OnLineDisplayComplete()

Method in TypewriterHandler

Summary

Stops the internal time counter, and finishes displaying the line.

public override void OnLineDisplayComplete()

OnLineTextWillAppear(MarkupParseResult,TMP_Text)

Method in TypewriterHandler

Summary

Calculates the points in the typewriter should pause at, and starts the typewriter's internal time counter.

public override void OnLineTextWillAppear(MarkupParseResult line, TMP_Text text)

Parameters

Name

Description

line

The line being presented.

TMPro.TMP_Text text

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

PrepareForLine(MarkupParseResult,TMP_Text)

Method in TypewriterHandler

Summary

Resets the typewriter back to the initial state.

public override void PrepareForLine(MarkupParseResult line, TMP_Text text)

Parameters

Name

Description

line

The line being presented.

TMPro.TMP_Text text

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

PresentCharacter(int,TMP_Text,CancellationToken)

Method in TypewriterHandler

Summary

Presents a single character of the line, at the appropriate point in time.

public override async YarnTask PresentCharacter(int currentCharacterIndex, TMP_Text text, CancellationToken cancellationToken)

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.

TypewriterHandler

Class in Yarn.Unity

Inherits from TemporalMarkupHandler

Summary

A TemporalMarkupHandler that progressively reveals the text of a line at a fixed rate of time.

public sealed class TypewriterHandler : TemporalMarkupHandler

Fields

Name

Description

The number of letters that will be shown per second.

An event that will be invoked for each

Methods

Name

Description

Stops the internal time counter, and finishes displaying the line.

Calculates the points in the typewriter should pause at, and starts the typewriter's internal time counter.

Resets the typewriter back to the initial state.

Presents a single character of the line, at the appropriate point in time.

PresentCharacter(int,TMP_Text,CancellationToken)

Method in TypewriterHandler

Summary

Presents a single character of the line, at the appropriate point in time.

public override async YarnTask PresentCharacter(int currentCharacterIndex, TMP_Text text, CancellationToken cancellationToken)

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.