LineView

Class in Yarn.Unity

Inherits from DialogueViewBase

Summary

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

public class LineView : DialogueViewBase

Fields

Name
Description

Controls whether this Line View will wait for user input before indicating that it has finished presenting a line.

The canvas group that contains the UI elements used by this Line View.

The TMPro.TextMeshProUGUI object that displays the character names found in dialogue lines.

The game object that represents an on-screen button that the user can click to continue to the next piece of dialogue.

The time that the fade effect will take to fade lines in.

The time that the fade effect will take to fade lines out.

The amount of time to wait after any line

The TMPro.TextMeshProUGUI object that displays the text of dialogue lines.

A Unity Event that is called each time a character is revealed during a typewriter effect.

A Unity Event that is called when a pause inside of the typewriter effect finishes and the typewriter has started once again.

A Unity Event that is called when a pause inside of the typewriter effect occurs.

The number of characters per second that should appear during a typewriter effect.

Controls whether the line view should fade in when lines appear, and fade out when lines disappear.

Methods

Name
Description

Creates a stack of typewriter pauses to use to temporarily halt the typewriter effect.

Applies the palette to the line based on it's markup.

Last updated

Yarn Spinner® and Secret Lab® are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.