LinePresenter
Class in Yarn.Unity
Inherits from DialoguePresenterBase
Summary
A Dialogue Presenter that presents lines of dialogue, using Unity UI elements.
public sealed class LinePresenter : DialoguePresenterBaseFields
| 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. |
| customTypewriter | |
| 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. |
| lettersPerSecond | The number of characters per second that should appear during a typewriter effect. |
| lineText | The TMPro.TMP_Text object that displays the text of dialogue lines. |
| showCharacterNameInLine | Controls whether the lineText object will show the character name present in the line or not. |
| useFadeEffect | Controls whether the line view should fade in when lines appear, and fade out when lines disappear. |
| wordsPerSecond |
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. |