Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Property in LineProviderBehaviour
Gets a value indicating whether this line provider is ready to provide LocalizedLine objects. The default implementation returns true
.
Subclasses should return false
when the required resources needed to deliver lines are not yet ready, and true
when they are.
Class in Yarn.Unity
Inherits from MonoBehaviour
A MonoBehaviour
that produces LocalizedLine s, for use in Dialogue Views.
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.
DialogueViewBase: A MonoBehaviour
that can present lines and options to the user, when it receives them from a DialogueRunner .
Name | Description |
---|---|
Name | Description |
---|---|
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 |
---|
Method in
Prepares and returns a from the specified Yarn.Line
.
This method should not be called if returns false
.
Name | Description |
---|
Method in
Called by Unity when the has first appeared in the scene.
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
.
| A collection of line IDs that the line provider should prepare for. |
|
The Yarn.Line
to produce the from.