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

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.

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

A TemporalMarkupHandler is an object that reacts to the delivery of a line of dialogue, and can optionally control the timing of that delivery.

public abstract class TemporalMarkupHandler : MonoBehaviour

Remarks

There are a number of cases where a line's delivery needs to have its timing controlled. For example, TypewriterHandler adds a small delay between each character, creating a 'typewriter' effect as each letter appears over time.

Another example of a TemporalMarkupHandler is an in-line event or animation, such as causing a character to play an animation (and waiting for that animation to complete before displaying the rest of the line).

Methods

Method in

Summary

Called after the last call to .

Remarks

This method is an opportunity for a to finalise its presentation after all of the characters in the line have been presented.

Method in

Summary

Called immediately before the first character in the line is presented.

Parameters

Method in TemporalMarkupHandler

Summary

Called when the line view receives the line, to prepare for showing the line.

public abstract void PrepareForLine(MarkupParseResult line, TMP_Text text);

Remarks

This method is called before any part of the line is visible, and is an opportunity to set up any part of the TemporalMarkupHandler 's display before the user can see it.

Parameters