DialogueViewBase

Class in Yarn.Unity

Inherits from AsyncDialogueViewBase

This class is obsolete and may be removed from a future version of Yarn Spinner: Use AsyncDialogueViewBase.

Summary

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

public abstract class DialogueViewBase : AsyncDialogueViewBase

Remarks

You should not use this class in new code. It exists to provide a compatibility layer for existing Yarn Spinner dialogue views. New dialogue views should subclass AsyncDialogueViewBase directly.

Fields

Name	Description
requestInterrupt	Represents the method that should be called when this view wants the line to be interrupted.

Methods

Name	Description
DialogueComplete()	Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.
DialogueStarted()	Called by the DialogueRunner to signal that dialogue has started.
DismissLine(Action)	Called by the DialogueRunner to signal that the view should dismiss its current line from display, and clean up.
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.
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.
RunLine(LocalizedLine,Action)	Called by the DialogueRunner to signal that a line should be displayed to the user.
RunLineAsync(LocalizedLine,LineCancellationToken)	Called by the DialogueRunner to signal that a line should be displayed to the user.
RunOptions(DialogueOption[],Action)	Called by the DialogueRunner to signal that a set of options should be displayed to the user.
RunOptionsAsync(DialogueOption[],CancellationToken)	Called by the DialogueRunner to signal that a set of options should be displayed to the user.
UserRequestedViewAdvancement()	Called by DialogueAdvanceInput to signal that the user has requested that the dialogue advance.