Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Class in Yarn.Unity
Inherits from MonoBehaviour
A MonoBehaviour
that produces LocalizedLine s.
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.
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Prepares and returns a LocalizedLine from the specified Yarn.Line
.
Signals to the line provider that lines with the provided line IDs may be presented shortly.
Called by Unity when the LineProviderBehaviour has first appeared in the scene.
Gets a value indicating whether this line provider is ready to provide LocalizedLine objects. The default implementation returns true
.
Property in
Gets a value indicating whether this line provider is ready to provide objects. The default implementation returns true
.
Method in LineProviderBehaviour
Prepares and returns a LocalizedLine from the specified Yarn.Line
.
This method should not be called if LinesAvailable returns false
.
A localized line, ready to be presented to the player.
Name | Description |
---|---|
Method in
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.
Name | Description |
---|
Yarn.Line
line
The Yarn.Line
to produce the LocalizedLine from.
| A collection of line IDs that the line provider should prepare for. |
Method in LineProviderBehaviour
Called by Unity when the LineProviderBehaviour has first appeared in the scene.
This method is public
virtual
to allow subclasses to override it.
Field in