Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
Method in LineProviderBehaviour
Prepares and returns a LocalizedLine from the specified Line .
This method should not be called if LinesAvailable returns false
.
A localized line, ready to be presented to the player.
Name | Description |
---|---|
Yarn.Line line
The Line to produce the LocalizedLine from.
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 |
---|
Class in
A UnityEngine.MonoBehaviour
that produces s, for use in Dialogue Views.
s use a to get s, which contain the localized information that classes use to present content to the player.
Subclasses of this abstract class may return subclasses of . For example, returns an AudioLocalizedLine
, which includes UnityEngine.AudioClip
; views that make use of audio can then access this additional data.
Name | Description |
---|
Name | Description |
---|
: A UnityEngine.MonoBehaviour
that can present lines and options to the user, when it receives them from a .
| A collection of line IDs that the line provider should prepare for. |
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.
Signals to the line provider that lines with the provided line IDs may be presented shortly. |
Gets the user's current locale identifier, as a BCP-47 code. |
Prepares and returns a from the specified .
Called by Unity when the has first appeared in the scene.
Gets a value indicating whether this line provider is ready to provide objects. The default implementation returns true
.
Property in
This value is used by the to control how certain replacement markers behave (for example, the [plural]
marker, which behaves differently depending on the user's locale.)