AsyncDialogueViewBase
Class in Yarn.Unity
Inherits from UnityEngine.MonoBehaviour
Summary
A UnityEngine.MonoBehaviour that can present lines and options to the user, when it receives them from a DialogueRunner .
Remarks
When the Dialogue Runner encounters content that the user should see - that is, lines or options - it sends that content to all of the dialogue views stored in Yarn.Unity.DialogueRunner.dialogueViews. The Dialogue Runner then waits until all Dialogue Views have reported that they have finished presenting the content.
To use this class, subclass it, and implement its required methods. Once you have written your subclass, attach it as a component to a UnityEngine.GameObject, and add this game object to the list of Dialogue Views in your scene's DialogueRunner.
Dialogue Views do not need to handle every kind of content that the Dialogue Runner might produce. For example, you might have one Dialogue View that handles Lines, and another that handles Options. The built-in LineView class is an example of this, in that it only handles Lines and does nothing when it receives Options.
You may also have multiple Dialogue Views that handle the same kind of content. For example, you may have a Dialogue View that receives Lines and uses them to play voice-over audio, and a second Dialogue View that also receives Lines and uses them to display on-screen subtitles.
Methods
Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.
Called by the DialogueRunner to signal that dialogue has started.
Called by the DialogueRunner to signal that a line should be displayed to the user.
Called by the DialogueRunner to signal that a set of options should be displayed to the user.
See Also
LineProviderBehaviour: A
UnityEngine.MonoBehaviourthat produces LocalizedLine s, for use in Dialogue Views.Yarn.Unity.DialogueRunner.dialogueViews:
Last updated