LineView

Class in Yarn.Unity

Inherits from DialogueViewBase

This class is obsolete and may be removed from a future version of Yarn Spinner.

Summary

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

public class LineView : DialogueViewBase

Fields

Name	Description
autoAdvance	Controls whether this Line View will wait for user input before indicating that it has finished presenting a line.
canvasGroup	The canvas group that contains the UI elements used by this Line View.
characterNameContainer	The gameobject that holds the characterNameText textfield.
characterNameText	The TMPro.TextMeshProUGUI object that displays the character names found in dialogue lines.
continueButton	The game object that represents an on-screen button that the user can click to continue to the next piece of dialogue.
fadeInTime	The time that the fade effect will take to fade lines in.
fadeOutTime	The time that the fade effect will take to fade lines out.
holdTime	The amount of time to wait after any line
lineText	The TMPro.TextMeshProUGUI 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.
onPauseEnded	A Unity Event that is called when a pause inside of the typewriter effect finishes and the typewriter has started once again.
onPauseStarted	A Unity Event that is called when a pause inside of the typewriter effect occurs.
palette
showCharacterNameInLineView	Controls whether the lineText object will show the character name present in the line or not.
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
AddLineBreaks(Markup.MarkupParseResult)	Inserts TextMeshPro line break markup in a line where Yarn line break attributes appear.
DialogueComplete()	Called by the DialogueRunner to signal that the dialogue has ended, and no more lines will be delivered.
DismissLine(Action)	Called by the DialogueRunner to signal that the view should dismiss its current line from display, and clean up.
InterruptLine(LocalizedLine,Action)	Called by the DialogueRunner to signal that a line has been interrupted, and that the Dialogue View should finish presenting its line as quickly as possible.
OnContinueClicked()	Called when the continueButton is clicked.
PaletteMarkedUpText(Markup.MarkupParseResult,MarkupPalette,bool)	Applies the palette to the line based on it's markup.
RunLine(LocalizedLine,Action)	Called by the DialogueRunner to signal that a line should be displayed to the user.
UserRequestedViewAdvancement()	Called by DialogueAdvanceInput to signal that the user has requested that the dialogue advance.