Method in CharacterColorView

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.

Method in CharacterColorView

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 updates the colour of a TMPro.TMP_Text object based on the character speaking a line. names.

public class CharacterColorView : Yarn.Unity.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 text views have their TMPro.TMP_Text.color property updated based on the colours configured in the Inspector.

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

Classes

Methods

Method in CharacterColorView

Summary

Updates the text colour of Yarn.Unity.CharacterColorView.lineTexts based on the character name of line , if any.

public override YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)

Remarks

If the line doesn't have a character name, or if the character name is not found in Yarn.Unity.CharacterColorView.colorData , Yarn.Unity.CharacterColorView.defaultColor is used.

Parameters

Returns

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

Class in CharacterColorView

Inherits from System.Object

Summary

Associates a named character with a colour to use in a CharacterColorView .

public class CharacterColorData

Fields

Method in

Summary

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

Remarks

This method is called when the Dialogue Runner wants to show a collection of options that the user should choose from. Each option is represented by a object, which contains information about the option.

When this method is called, the Dialogue View should display appropriate user interface elements that let the user choose among the options.

This method should await until an option is selected, and then return the selected option. If this view doesn't handle options, or is otherwise unable to select an option, it should return YarnAsync.NoOptionSelected. The dialogue runner will wait for all dialogue views to return, so if a dialogue view doesn't or can't handle options, it's good practice to return as soon as possible.

If the cancellationToken becomes cancelled, this means that the dialogue runner no longer needs this dialogue view to make a selection, and this method should return as soon as possible; its return value will not be used.

Parameters

Returns

A task that indicates which option was selected, or that this dialogue view did not select an option.

See Also

• YarnAsync.NoOptionSelected

Field in

Summary

The name of a speaking character.

Field in

Summary

The text colour associated with this character.