VoiceOverView

Class in Yarn.Unity

Inherits from AsyncDialogueViewBase

Summary

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

public class VoiceOverView : AsyncDialogueViewBase

Fields

Name	Description
audioSource	The UnityEngine.AudioSource that this voice over view will play its audio from.
dialogueRunner	The dialogue runner to notify of line completion.
endLineWhenVoiceoverComplete	If true , the voice over view will request that the dialogue runner proceed to the next line when audio for the line has finished playing.
fadeOutTimeOnLineFinish	The fade out time when the line is interrupted during playback.
waitTimeAfterLineComplete	The amount of time after playback has completed before this view reports that it's finished delivering the line.
waitTimeBeforeLineStart	The amount of time to wait before starting playback of the line.

Methods

Name	Description
OnDialogueCompleteAsync()	Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.
OnDialogueStartedAsync()	Called by the DialogueRunner to signal that dialogue has started.
RunLineAsync(LocalizedLine,LineCancellationToken)	Begins playing the associated audio for the specified line.
RunOptionsAsync(DialogueOption[],CancellationToken)	Called by the DialogueRunner to signal that a set of options should be displayed to the user.

See Also

• DialogueViewBase: Implements the Yarn Spinner 2 callback-based API for dialogue views using Yarn Spinner 3.