RunLineAsync(LocalizedLine,LineCancellationToken)

Method in AsyncDialogueViewBase

Summary

Called by the DialogueRunner to signal that a line should be displayed to the user.

public abstract YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token);

Remarks

When this method is called, the Dialogue View should present the line to the user. The content to present is contained within the line parameter, which contains information about the line in the user's current locale.

It's up to the Dialogue View to decide what "presenting" the line may mean; for example, showing on-screen text, playing voice-over audio, or updating on-screen portraits to show a picture of the speaking character.

The DialogueRunner will wait until the tasks from all of its dialogue views have completed before continuing to the next piece of content. If your dialogue view does not need to handle the line, it should return immediately.

The value of the line parameter is produced by the Dialogue Runner's LineProviderBehaviour.

The default implementation of this method takes no action and returns immediately.

Parameters

Name	Description
Yarn.Unity.LocalizedLine line	The line to present.
Yarn.Unity.LineCancellationToken token	A LineCancellationToken that represents whether the dialogue view should hurry it its presentation of the line, or stop showing the current line.

Returns

A task that completes when the dialogue view has finished showing the line to the user.

See Also

• AsyncDialogueViewBase.RunOptionsAsync(DialogueOption[],CancellationToken): Called by the DialogueRunner to signal that a set of options should be displayed to the user.