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

Remarks

DialogueRunners use a LineProviderBehaviour to get LocalizedLines, 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 UnityEngine.AudioClip; views that make use of audio can then access this additional data.

Methods

Name	Description
GetLocalizedLine(Yarn.Line)	Prepares and returns a LocalizedLine from the specified Line .
PrepareForLines(IEnumerable)	Signals to the line provider that lines with the provided line IDs may be presented shortly.
Start()	Called by Unity when the LineProviderBehaviour has first appeared in the scene.

Properties

Name	Description
LinesAvailable	Gets a value indicating whether this line provider is ready to provide LocalizedLine objects. The default implementation returns true .
LocaleCode	Gets the user's current locale identifier, as a BCP-47 code.
YarnProject

See Also

• DialogueViewBase: A UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .