Field in DialogueCharacterNameView

Summary

Invoked when a line is received that doesn't contain a character name.

public UnityEvent onNameNotPresent;

Remarks

Games can use this event to hide the name UI.

See Also

• DialogueCharacterNameView.onNameUpdate: Invoked when a line is received that contains a character name. The name is given as the parameter.

Field in DialogueCharacterNameView

Summary

Invoked when a line is received that contains a character name. The name is given as the parameter.

public UnityEventString onNameUpdate;

See Also

• DialogueCharacterNameView.onNameNotPresent: Invoked when a line is received that doesn't contain a character name.

Method in DialogueCharacterNameView

Summary

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

public override YarnTask OnDialogueCompleteAsync()

Remarks

This method is called after the last piece of content (that is, lines, options or commands) finished running.

This method is a good place to perform tasks like dismissing on-screen dialogue UI (for example, turning off a letterboxing effect, or hiding dialogue UI elements.)

Returns

A task that represents any work done by this dialogue view in order to clean up after running dialogue.

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

Methods

Method in DialogueCharacterNameView

Summary

Takes no action; this dialogue view does not handle options.

public override YarnTask<DialogueOption?> RunOptionsAsync(DialogueOption[] dialogueOptions, CancellationToken cancellationToken)

Parameters

Returns

A task that completes when the dialogue view has finished showing the line to the user.

Method in DialogueCharacterNameView

Summary

Called by the DialogueRunner to signal that dialogue has started.

public override YarnTask OnDialogueStartedAsync()

Remarks

This method is called before any content (that is, lines, options or commands) are delivered.

This method is a good place to perform tasks like preparing on-screen dialogue UI (for example, turning on a letterboxing effect, or making dialogue UI elements visible.)

Returns

A task that represents any work done by this dialogue view in order to get ready for dialogue to run.

Field in

Summary

Invoked when the dialogue is started.

Method in DialogueCharacterNameView

Summary

Invokes the onNameUpdate or onNameNotPresent events, depending on the contents of line .

public override YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)

Parameters

Returns

A task that completes when the dialogue view has finished showing the line to the user.