UnityLocalisedLineProvider.GetLocalizedLineAsync(Line,CancellationToken)

Method in UnityLocalisedLineProvider

Summary

Prepares and returns a LocalizedLine from the specified Line .

public override async YarnTask<LocalizedLine> GetLocalizedLineAsync(Line line, CancellationToken cancellationToken)

Parameters

NameDescription
Yarn.Line lineThe Line to produce the LocalizedLine from.
CancellationToken cancellationTokenA cancellation token that indicates whether the process of fetching the localised version of line should be cancelled.

Returns

A localized line, ready to be presented to the player.