LineAdvancer
Class in Yarn.Unity
Inherits from DialoguePresenterBase
Summary
A dialogue presenter that listens for user input and sends requests to a DialogueRunner to advance the presentation of the current line, either by asking a dialogue runner to hurry up its delivery, advance to the next line, or cancel the entire dialogue session.
public sealed class LineAdvancer : DialoguePresenterBase, IActionMarkupHandlerEnums
| Name | Description |
|---|---|
| InputMode | The type of input that this line advancer responds to. |
Fields
| Name | Description |
|---|---|
| advanceRequestsBeforeCancellingLine | The number of times that a ‘hurry up’ signal occurs before the line advancer requests that the next line be shown. |
| multiAdvanceIsCancel | If true , repeatedly signalling that the line should be hurried up will cause the line advancer to request that the next line be shown. |
Methods
| Name | Description |
|---|---|
| OnCharacterWillAppear(int,MarkupParseResult,CancellationToken) | |
| OnDialogueCompleteAsync() | Called by a dialogue runner when dialogue ends to remove the input action handlers. |
| OnDialogueStartedAsync() | Called by a dialogue runner when dialogue starts to add input action handlers for advancing the line. |
| OnLineDisplayBegin(MarkupParseResult,TMP_Text) | |
| OnLineDisplayComplete() | |
| OnLineWillDismiss() | |
| OnPrepareForLine(MarkupParseResult,TMP_Text) | |
| RequestDialogueCancellation() | Requests that the dialogue runner to instruct all line views to dismiss their content, and then stops the dialogue. |
| RequestLineHurryUp() | Requests that the line be hurried up. |
| RequestNextLine() | Requests that the dialogue runner proceeds to the next line. |
| RequestOptionHurryUp() | |
| RunLineAsync(LocalizedLine,LineCancellationToken) | Called by a dialogue presenter to signal that a line is running. |
| RunOptionsAsync(DialogueOption[],LineCancellationToken) | Called by a dialogue presenter to signal that options are running. |