# LinePresenter

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

Inherits from [`DialoguePresenterBase`](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguepresenterbase)

## Summary

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

```csharp
public sealed class LinePresenter : DialoguePresenterBase
```

## Fields

| Name                                                                                                                                                    | Description                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [autoAdvance](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.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](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.autoadvancedelay)               | The amount of time after the line finishes appearing before automatically ending the line, in seconds.                                                                                                         |
| [canvasGroup](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.canvasgroup)                         | The canvas group that contains the UI elements used by this Line View.                                                                                                                                         |
| [characterNameContainer](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.characternamecontainer)   | The game object that holds the [characterNameText](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.characternametext) text field.                         |
| [characterNameText](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.characternametext)             | The `TMPro.TMP_Text` object that displays the character names found in dialogue lines.                                                                                                                         |
| [customTypewriter](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.customtypewriter)               |                                                                                                                                                                                                                |
| [fadeDownDuration](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.fadedownduration)               | The time that the fade effect will take to fade lines out.                                                                                                                                                     |
| [fadeUpDuration](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.fadeupduration)                   | The time that the fade effect will take to fade lines in.                                                                                                                                                      |
| [lettersPerSecond](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.letterspersecond)               | The number of characters per second that should appear during a typewriter effect.                                                                                                                             |
| [lineText](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.linetext)                               | The `TMPro.TMP_Text` object that displays the text of dialogue lines.                                                                                                                                          |
| [showCharacterNameInLine](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.showcharacternameinline) | Controls whether the [lineText](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.linetext) object will show the character name present in the line or not. |
| [useFadeEffect](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.usefadeeffect)                     | Controls whether the line view should fade in when lines appear, and fade out when lines disappear.                                                                                                            |
| [wordsPerSecond](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.wordspersecond)                   |                                                                                                                                                                                                                |

## Methods

| Name                                                                                                                                                                   | Description                                                                                                                                                                              |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [OnDialogueCompleteAsync()](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.ondialoguecompleteasync)              | Called by the [DialogueRunner](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguerunner) to signal that the dialogue has ended, and no more lines will be delivered. |
| [OnDialogueStartedAsync()](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.ondialoguestartedasync)                | Called by the [DialogueRunner](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.dialoguerunner) to signal that dialogue has started.                                        |
| [RunLineAsync(LocalizedLine,LineCancellationToken)](https://docs.yarnspinner.dev/api/csharp/yarn.unity/yarn.unity.linepresenter/yarn.unity.linepresenter.runlineasync) | Presents a line using the configured text view.                                                                                                                                          |