Method in UnityLocalisedLineProvider

Summary

Signals to the line provider that lines with the provided line IDs may be presented shortly.

public override async YarnTask PrepareForLinesAsync(IEnumerable<string> lineIDs, CancellationToken cancellationToken)

Remarks

This method allows implementing classes a chance to prepare any neccessary resources needed to present these lines, like pre-loading voice-over audio. The default implementation does nothing.

Parameters

Method in UnityLocalisedLineProvider

Summary

Removes all marker processors that handle markers named attributeName .

public override void DeregisterMarkerProcessor(string attributeName)

Parameters

Method in UnityLocalisedLineProvider

Summary

Called by Unity when the LineProviderBehaviour has first appeared in the scene.

public override void Start()

Remarks

This method is public virtual to allow subclasses to override it.

Method in UnityLocalisedLineProvider

Summary

Adds a new marker processor to the line provider.

public override void RegisterMarkerProcessor(string attributeName, IAttributeMarkerProcessor markerProcessor)

Parameters

Method in UnityLocalisedLineProvider

Summary

Prepares and returns a LocalizedLine from the specified Line .

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

Parameters

Returns

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

Class in Yarn.Unity.UnityLocalization

Inherits from LineProviderBehaviour

Summary

A line provider that uses the Unity Localization system to get localized content for Yarn lines.

public class UnityLocalisedLineProvider : LineProviderBehaviour

Methods

Properties

Property in

Summary

Gets the user's current locale identifier, as a BCP-47 code.

Remarks

This value is used to control how certain replacement markers behave (for example, the [plural] marker, which behaves differently depending on the user's locale.)