> For the complete documentation index, see [llms.txt](https://docs.yarnspinner.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview.md).

# LineView

Class in [Yarn.Unity](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity.md)

Inherits from [`DialogueViewBase`](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialogueviewbase.md)

## Summary

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

```csharp
public class LineView : DialogueViewBase
```

## Fields

| Name                                                                                                                                                         | Description                                                                                                                                                                                                 |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [autoAdvance](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.autoadvance.md)                                 | Controls whether this Line View will wait for user input before indicating that it has finished presenting a line.                                                                                          |
| [canvasGroup](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.canvasgroup.md)                                 | The canvas group that contains the UI elements used by this Line View.                                                                                                                                      |
| [characterNameContainer](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.characternamecontainer.md)           | The gameobject that holds the [characterNameText](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.characternametext.md) textfield.                           |
| [characterNameText](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.characternametext.md)                     | The `TMPro.TextMeshProUGUI` object that displays the character names found in dialogue lines.                                                                                                               |
| [continueButton](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.continuebutton.md)                           | The game object that represents an on-screen button that the user can click to continue to the next piece of dialogue.                                                                                      |
| [fadeInTime](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.fadeintime.md)                                   | The time that the fade effect will take to fade lines in.                                                                                                                                                   |
| [fadeOutTime](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.fadeouttime.md)                                 | The time that the fade effect will take to fade lines out.                                                                                                                                                  |
| [holdTime](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.holdtime.md)                                       | The amount of time to wait after any line                                                                                                                                                                   |
| [lineText](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.linetext.md)                                       | The `TMPro.TextMeshProUGUI` object that displays the text of dialogue lines.                                                                                                                                |
| [onCharacterTyped](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.oncharactertyped.md)                       | A Unity Event that is called each time a character is revealed during a typewriter effect.                                                                                                                  |
| [onPauseEnded](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.onpauseended.md)                               | A Unity Event that is called when a pause inside of the typewriter effect finishes and the typewriter has started once again.                                                                               |
| [onPauseStarted](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.onpausestarted.md)                           | A Unity Event that is called when a pause inside of the typewriter effect occurs.                                                                                                                           |
| [palette](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.palette.md)                                         |                                                                                                                                                                                                             |
| [showCharacterNameInLineView](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.showcharacternameinlineview.md) | Controls whether the [lineText](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.linetext.md) object will show the character name present in the line or not. |
| [typewriterEffectSpeed](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.typewritereffectspeed.md)             | The number of characters per second that should appear during a typewriter effect.                                                                                                                          |
| [useFadeEffect](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.usefadeeffect.md)                             | Controls whether the line view should fade in when lines appear, and fade out when lines disappear.                                                                                                         |
| [useTypewriterEffect](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.usetypewritereffect.md)                 | Controls whether the text of [lineText](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.linetext.md) should be gradually revealed over time.                 |

## Methods

| Name                                                                                                                                                                                      | Description                                                                                                                                                                                                                                          |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [AddLineBreaks(Markup.MarkupParseResult)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.addlinebreaks.md)                                |                                                                                                                                                                                                                                                      |
| [DialogueComplete()](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.dialoguecomplete.md)                                                  | Called by the [DialogueRunner](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) to signal that the dialogue has ended, and no more lines will be delivered.                                                      |
| [DismissLine(Action)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.dismissline.md)                                                      | Called by the [DialogueRunner](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) to signal that the view should dismiss its current line from display, and clean up.                                              |
| [GetPauseDurationsInsideLine(Markup.MarkupParseResult)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.getpausedurationsinsideline.md)    | Creates a stack of typewriter pauses to use to temporarily halt the typewriter effect.                                                                                                                                                               |
| [InterruptLine(LocalizedLine,Action)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.interruptline.md)                                    | Called by the [DialogueRunner](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) to signal that a line has been interrupted, and that the Dialogue View should finish presenting its line as quickly as possible. |
| [OnContinueClicked()](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.oncontinueclicked.md)                                                | Called when the [continueButton](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.continuebutton.md) is clicked.                                                                                       |
| [PaletteMarkedUpText(Markup.MarkupParseResult,MarkupPalette,bool)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.palettemarkeduptext.md) | Applies the `palette` to the line based on it's markup.                                                                                                                                                                                              |
| [RunLine(LocalizedLine,Action)](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.runline.md)                                                | Called by the [DialogueRunner](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialoguerunner.md) to signal that a line should be displayed to the user.                                                                           |
| [UserRequestedViewAdvancement()](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.lineview/yarn.unity.lineview.userrequestedviewadvancement.md)                          | Called by [DialogueAdvanceInput](https://docs.yarnspinner.dev/2.5/api/csharp/yarn.unity/yarn.unity.dialogueadvanceinput.md) to signal that the user has requested that the dialogue advance.                                                         |
