Class in Yarn.Unity

Inherits from MonoBehaviour

Summary

A 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 AudioClip; views that make use of audio can then access this additional data.

Fields

Methods

Properties

See Also

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

Property in

Summary

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

Remarks

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

Method in

Summary

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

Remarks

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

Method in

Summary

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

Remarks

Subclasses of can override this to prepare any neccessary resources needed to present these lines, like pre-loading voice-over audio. The default implementation does nothing.

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

Parameters

Field in

Summary

Property in LineProviderBehaviour

Summary

public YarnProject YarnProject { get; set; }

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.