Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Class in Yarn.Unity
Inherits from DialogueViewBase
A subclass of DialogueViewBase that plays voice-over AudioClip
s for lines of dialogue.
This class plays audio clip assets that are provided by an AudioLineProvider . To use a VoiceOverView in your game, your DialogueRunner must be configured to use an AudioLineProvider , and your Yarn projects must be configured to use voice-over audio assets. For more information, see Localization and Assets .
DialogueViewBase: A MonoBehaviour
that can present lines and options to the user, when it receives them from a DialogueRunner .
Name | Description |
---|---|
Name | Description |
---|---|
The AudioSource
that this voice over view will play its audio from.
The fade out time when UserRequestedViewAdvancement() is called.
The amount of time after playback has completed before this view reports that it's finished delivering the line.
The amount of time to wait before starting playback of the line.
Ends any existing playback, and reports that the line has finished dismissing.
Interrupts the playback of the specified line, and quickly fades the playback to silent.
Begins playing the associated audio for the specified line.
Signals to this dialogue view that the user would like to skip playback.
Method in VoiceOverView
Interrupts the playback of the specified line, and quickly fades the playback to silent.
This method is not intended to be called from your code. Instead, the DialogueRunner class will call it at the appropriate time.
DialogueViewBase.InterruptLine(LocalizedLine,Action): Called by the DialogueRunner to signal that a line has been interrupted, and that the Dialogue View should finish presenting its line as quickly as possible.
Name | Description |
---|---|
Yarn.Unity.LocalizedLine dialogueLine
The current line that is being presented.
Action
onDialogueLineFinished
The method that should be called after the line has finished being presented.
Field in VoiceOverView
The AudioSource
that this voice over view will play its audio from.
If this is null
, a new AudioSource
will be added at runtime.
Field in VoiceOverView
The amount of time after playback has completed before this view reports that it's finished delivering the line.
Method in VoiceOverView
Ends any existing playback, and reports that the line has finished dismissing.
This method is not intended to be called from your code. Instead, the DialogueRunner class will call it at the appropriate time.
DialogueViewBase.DismissLine(Action): Called by the DialogueRunner to signal that the view should dismiss its current line from display, and clean up.
Name | Description |
---|---|
Field in
The fade out time when is called.
Method in
This method is not intended to be called from your code. Instead, the class will call it at the appropriate time.
Name | Description |
---|
: Called by the to signal that a line should be displayed to the user.
Method in
When this method is called, this view indicates to its that the line should be interrupted.
: Called by the to signal that a line has been interrupted, and that the Dialogue View should finish presenting its line as quickly as possible.
Action
onDismissalComplete
The method that should be called when the view has finished dismissing the line.
The content of the line that should be presented to the user. |
| The method that should be called after the line has finished being presented. |
dialogueLine