LineProviderBehaviour

Class in Yarn.Unity

Inherits from UnityEngine.MonoBehaviour

Summary

A UnityEngine.MonoBehaviour that produces LocalizedLine s, for use in Dialogue Views.

public abstract class LineProviderBehaviour : MonoBehaviour, ILineProvider

Remarks

DialogueRunner s use a LineProviderBehaviour to get LocalizedLine s, which contain the localized information that is presented to the player through dialogue views.

Methods

Name	Description
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,IAttributeMarkerProcessor)	Adds a new marker processor to the line provider.
Start()	Called by Unity when the LineProviderBehaviour has first appeared in the scene.

Properties

Name	Description
LinesAvailable
LocaleCode	Gets the user's current locale identifier, as a BCP-47 code.
YarnProject	The YarnProject that contains the localized data for lines.

See Also

• DialogueViewBase: Implements the Yarn Spinner 2 callback-based API for dialogue views using Yarn Spinner 3.