Field in VoiceOverView

Summary

The UnityEngine.AudioSource that this voice over view will play its audio from.

public AudioSource audioSource;

Remarks

If this is null , a new UnityEngine.AudioSource will be added at runtime.

Field in VoiceOverView

Summary

The amount of time to wait before starting playback of the line.

public float waitTimeBeforeLineStart = 0f;

Method in

Summary

Ends any existing playback, and reports that the line has finished dismissing.

Remarks

Parameters

See Also

• : Called by the to signal that the view should dismiss its current line from display, and clean up.

Field in VoiceOverView

Summary

The fade out time when UserRequestedViewAdvancement() is called.

public float fadeOutTimeOnLineFinish = 0.05f;

Field in VoiceOverView

Summary

The amount of time after playback has completed before this view reports that it's finished delivering the line.

public float waitTimeAfterLineComplete = 0f;

Method in VoiceOverView

Summary

Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.

public override void DialogueComplete()

Remarks

This method is called after the last piece of content (that is, lines, options or commands) finished running.

This method is a good place to perform tasks like dismissing on-screen dialogue UI (for example, turning off a letterboxing effect, or hiding dialogue UI elements.)

If Stop() is called, this method is how your custom views are informed of this. This allows you to skip over the normal flow of dialogue, so please use this method to clean up your views.

Method in VoiceOverView

Summary

Signals to this dialogue view that the user would like to skip playback.

public override void UserRequestedViewAdvancement()

Remarks

When this method is called, this view indicates to its DialogueRunner that the line should be interrupted.

If this view is not currently playing any audio, this method does nothing.

See Also

• 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.

Class in Yarn.Unity

Inherits from DialogueViewBase

Summary

A subclass of DialogueViewBase that plays voice-over UnityEngine.AudioClip s for lines of dialogue.

public class VoiceOverView : DialogueViewBase

Remarks

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 .

Fields

Methods

See Also

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

Method in VoiceOverView

Summary

Interrupts the playback of the specified line, and quickly fades the playback to silent.

public override void InterruptLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Remarks

Parameters

See Also

• 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.

Method in VoiceOverView

Summary

Begins playing the associated audio for the specified line.

public override void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Remarks

Parameters

See Also

• DialogueViewBase.RunLine(LocalizedLine,Action): Called by the DialogueRunner to signal that a line should be displayed to the user.