AsyncLineView

Class in Yarn.Unity

Inherits from AsyncDialogueViewBase

Summary

A Dialogue View that presents lines of dialogue, using Unity UI elements.

public class AsyncLineView : AsyncDialogueViewBase

Fields

Name	Description
autoAdvance	Controls whether this Line View will automatically to the Dialogue Runner that the line is complete as soon as the line has finished appearing.
autoAdvanceDelay	The amount of time after the line finishes appearing before automatically ending the line, in seconds.
canvasGroup	The canvas group that contains the UI elements used by this Line View.
characterNameContainer	The game object that holds the characterNameText text field.
characterNameText	The TMPro.TMP_Text object that displays the character names found in dialogue lines.
continueButton	The UnityEngine.UI.Button that represents an on-screen button that the user can click to continue to the next piece of dialogue.
fadeDownDuration	The time that the fade effect will take to fade lines out.
fadeUpDuration	The time that the fade effect will take to fade lines in.
lineText	The TMPro.TMP_Text object that displays the text of dialogue lines.
onCharacterTyped	A Unity Event that is called each time a character is revealed during a typewriter effect.
showCharacterNameInLineView	Controls whether the lineText object will show the character name present in the line or not.
temporalProcessors	A list of TemporalMarkupHandler objects that will be used to handle markers in the line.
typewriterEffectSpeed	The number of characters per second that should appear during a typewriter effect.
useFadeEffect	Controls whether the line view should fade in when lines appear, and fade out when lines disappear.
useTypewriterEffect	Controls whether the text of lineText should be gradually revealed over time.

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)	Presents a line using the configured text view.
RunOptionsAsync(DialogueOption[],CancellationToken)	Called by the DialogueRunner to signal that a set of options should be displayed to the user.