Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that the end of a node has been reached.

public virtual void NodeComplete(string nextNode, Action onComplete)

Remarks

This method may be called multiple times before DialogueComplete() is called. If this method returns Dialogue.HandlerExecutionType.ContinueExecution , do not call the onComplete method.

The default implementation does nothing.

Parameters

Method in DialogueViewBase

Summary

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

public virtual void DialogueComplete()

Remarks

The default implementation does nothing.

Method in DialogueViewBase

Summary

Signals that a conversation has started.

public virtual void DialogueStarted()

Method in DialogueViewBase

Summary

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

public virtual void DismissLine(Action onDismissalComplete)

Parameters

Method in DialogueViewBase

Summary

Called by the DialogueRunner to indicate that the line that this view is delivering has changed state.

public virtual void OnLineStatusChanged(LocalizedLine dialogueLine)

Remarks

Subclasses of DialogueViewBase should override this method to be notified when a line has become interrupted, and when the line has finished being delivered by all views.

The default implementation does nothing.

Parameters

See Also

• LineStatus: The presentation status of a LocalizedLine .

Class in Yarn.Unity

Inherits from MonoBehaviour

Summary

A MonoBehaviour that can present the data of a dialogue executed by a DialogueRunner to the user. The DialogueRunner uses subclasses of this type to relay information to and from the user, and to pause and resume the execution of the YarnScript .

public abstract class DialogueViewBase : MonoBehaviour

Remarks

The term "view" is meant in the broadest sense, e.g. a view on the dialogue (MVVM pattern). Therefore, this abstract class only defines how a specific view on the dialogue should communicate with the DialogueRunner (e.g. display text or trigger a voice over clip). How to present the content to the user will be the responsibility of all classes inheriting from this class.

The inheriting classes will receive a LocalizedLine and can be in one of the stages defined in DialogueLineStatus while presenting it.

Methods

See Also

• DialogueRunner.dialogueViews: The View classes that will present the dialogue to the user.

• DialogueUI

Method in

Summary

Signals that the user wants to go to the next line.

Remarks

This method is generally called by a "continue" button, and causes the DialogueUI to signal the to proceed to the next piece of content.

If this method is called before the line has finished appearing (that is, before the line's status changes to ), the line's status will change to , and will be called to notify the view.

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that a line should be displayed to the user.

public virtual void RunLine(LocalizedLine dialogueLine, Action onDialogueLineFinished)

Parameters

Method in DialogueViewBase

Summary

Called by the DialogueRunner to signal that a set of options should be displayed to the user.

public virtual void RunOptions(DialogueOption[] dialogueOptions, Action<int> onOptionSelected)

Remarks

When this method is called, the DialogueRunner will pause execution until the `onOptionSelected` method is called.

If your scene includes multiple dialogue views that override this method, they will all receive a call each time the dialogue system presents options to the player. You must ensure that only one of them calls the onOptionSelected method.

Parameters