DialogueCharacterNameView

Class in Yarn.Unity

Inherits from AsyncDialogueViewBase

Summary

A subclass of DialogueViewBase that displays character names.

public class DialogueCharacterNameView : AsyncDialogueViewBase

Remarks

This class uses the `character` attribute on lines that it receives to determine its content. When the view's RunLineAsync(LocalizedLine,LineCancellationToken) method is called with a line whose Text contains a `character` attribute, the onNameUpdate event is fired. If the line does not contain such an attribute, the onNameNotPresent event is fired instead.

This view does not present any options or handle commands. It's intended to be used alongside other subclasses of AsyncDialogueViewBase.

Fields

Name	Description
onDialogueStarted	Invoked when the dialogue is started.
onNameNotPresent	Invoked when a line is received that doesn't contain a character name.
onNameUpdate	Invoked when a line is received that contains a character name. The name is given as the parameter.

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)	Invokes the onNameUpdate or onNameNotPresent events, depending on the contents of line .
RunOptionsAsync(DialogueOption[],CancellationToken)	Takes no action; this dialogue view does not handle options.