All pages
Powered by GitBook
1 of 9

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.

DeregisterMarkerProcessor(string)

Method in LineProviderBehaviour

Summary

Removes all marker processors that handle markers named attributeName .

public abstract void DeregisterMarkerProcessor(string attributeName);

Parameters

Name
Description

string attributeName

The name of the marker to remove processors for.

GetLocalizedLineAsync(Line,CancellationToken)

Method in LineProviderBehaviour

Summary

Prepares and returns a LocalizedLine from the specified Line .

public abstract YarnTask<LocalizedLine> GetLocalizedLineAsync(Line line, CancellationToken cancellationToken);

Parameters

Name
Description

Line line

The Line to produce the LocalizedLine from.

CancellationToken cancellationToken

A 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.

PrepareForLinesAsync(IEnumerable<string>,CancellationToken)

Method in LineProviderBehaviour

Summary

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

public virtual 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.

Not every line may run; this method serves as a way to give the line provider advance notice that a line may run, not will run.

Parameters

Name
Description

IEnumerable<string> lineIDs

A collection of line IDs that the line provider should prepare for.

CancellationToken cancellationToken

A cancellation token that indicates whether the operation should be cancelled.

RegisterMarkerProcessor(string,IAttributeMarkerProcessor)

Method in LineProviderBehaviour

Summary

Adds a new marker processor to the line provider.

public abstract void RegisterMarkerProcessor(string attributeName, IAttributeMarkerProcessor markerProcessor);

Parameters

Name
Description

string attributeName

The name of the markers to use markerProcessor for.

IAttributeMarkerProcessor markerProcessor

The marker processor to add.

Start()

Method in LineProviderBehaviour

Summary

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

public virtual void Start()

Remarks

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

LinesAvailable

Property in LineProviderBehaviour

Summary

public virtual bool LinesAvailable { get };

LocaleCode

Property in LineProviderBehaviour

Summary

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

public abstract string LocaleCode { get; set; }

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.)

YarnProject

Property in LineProviderBehaviour

Summary

The YarnProject that contains the localized data for lines.

public YarnProject? YarnProject { get; set; }

Remarks

This property is set at run-time by the object that will be requesting content (typically a DialogueRunner ).