Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.96 KB

yarn.unity.voiceoverview.md

File metadata and controls

49 lines (31 loc) · 2.96 KB
Raw

VoiceOverView

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

Name Description
audioSource The UnityEngine.AudioSource that this voice over view will play its audio from.
fadeOutTimeOnLineFinish The fade out time when UserRequestedViewAdvancement() is called.
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
DialogueComplete() Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.
DismissLine(Action) Ends any existing playback, and reports that the line has finished dismissing.
InterruptLine(LocalizedLine,Action) Interrupts the playback of the specified line, and quickly fades the playback to silent.
RunLine(LocalizedLine,Action) Begins playing the associated audio for the specified line.
UserRequestedViewAdvancement() Signals to this dialogue view that the user would like to skip playback.

See Also