Field in LineProviderBehaviour

Summary

public string textLanguageCode = System.Globalization.CultureInfo.CurrentCulture.Name;

Method in LineProviderBehaviour

Summary

Prepares and returns a LocalizedLine from the specified Yarn.Line .

public abstract LocalizedLine GetLocalizedLine(Yarn.Line line);

Remarks

This method should not be called if LinesAvailable returns false .

Parameters

Returns

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

Property in LineProviderBehaviour

Summary

Gets a value indicating whether this line provider is ready to provide LocalizedLine objects. The default implementation returns true .

public virtual bool LinesAvailable { get };

Remarks

Subclasses should return false when the required resources needed to deliver lines are not yet ready, and true when they are.

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.

Method in LineProviderBehaviour

Summary

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

public virtual void PrepareForLines(IEnumerable<string> lineIDs)

Remarks

Subclasses of LineProviderBehaviour can override this 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.

When this method is run, the value returned by the LinesAvailable property should change to false until the necessary resources have loaded.

Parameters

Property in

Summary

Class in Yarn.Unity

Inherits from MonoBehaviour

Summary

A MonoBehaviour that produces LocalizedLine s.

public abstract class LineProviderBehaviour : MonoBehaviour

Remarks

DialogueRunner s use a LineProviderBehaviour to get LocalizedLine s, which contain the localized information that DialogueViewBase classes use to present content to the player.

Subclasses of this abstract class may return subclasses of LocalizedLine . For example, AudioLineProvider returns an AudioLocalizedLine , which includes AudioClip ; views that make use of audio can then access this additional data.

Fields

Methods

Properties