ILineProvider

Interface in Yarn.Unity

Summary

Contains methods for retrieving user-facing localized content, given non-localized line IDs.

public interface ILineProvider

Methods

NameDescription
DeregisterMarkerProcessor(string)Removes all marker processors that handle markers named attributeName .
GetLocalizedLineAsync(Line,CancellationToken)Prepares and returns a LocalizedLine from the specified Line .
PrepareForLinesAsync(IEnumerable,CancellationToken)Signals to the line provider that lines with the provided line IDs may be presented shortly.
RegisterMarkerProcessor(string,Yarn.Markup.IAttributeMarkerProcessor)Adds a new marker processor to the line provider.

Properties

NameDescription
LocaleCodeGets the line provider’s current locale identifier, as a BCP-47 code.
YarnProjectThe YarnProject that contains the localized data for lines.