LineAdvancer
public sealed class LineAdvancer : DialoguePresenterBase, IActionMarkupHandlerInherits from Yarn.Unity.DialoguePresenterBase
Implements Yarn.Unity.IActionMarkupHandler
#Nested Types
- InputMode enumThe type of input that this line advancer responds to.
#Properties
#SeparateHurryUpAndAdvanceControls
public bool SeparateHurryUpAndAdvanceControls { get }Type Boolean
#Methods
#OnCharacterWillAppear(int, MarkupParseResult, CancellationToken)
public YarnTask OnCharacterWillAppear(int currentCharacterIndex, MarkupParseResult line, CancellationToken cancellationToken)Parameters
currentCharacterIndexintcancellationTokenCancellationToken
Returns YarnTask
#OnDialogueCompleteAsync(CancellationToken)
public override YarnTask OnDialogueCompleteAsync(CancellationToken token)Parameters
tokenCancellationToken
Returns YarnTask: A completed task.
#OnDialogueStartedAsync(CancellationToken)
public override YarnTask OnDialogueStartedAsync(CancellationToken token)Parameters
tokenCancellationToken
Returns YarnTask: A completed task.
#OnLineDisplayBegin(MarkupParseResult, TMP_Text)
public void OnLineDisplayBegin(MarkupParseResult line, TMP_Text text)Parameters
textTMP_Text
#OnLineDisplayComplete()
public void OnLineDisplayComplete()#OnLineWillDismiss()
public void OnLineWillDismiss()#OnPrepareForLine(MarkupParseResult, TMP_Text)
public void OnPrepareForLine(MarkupParseResult line, TMP_Text text)Parameters
textTMP_Text
#OnValidate()
public void OnValidate()#RequestDialogueCancellation()
public void RequestDialogueCancellation()#RequestHurryUpContent()
public void RequestHurryUpContent()#RequestLineHurryUp() Obsolete
Changes to the dialogue runner mean there is no longer a difference between hurrying up lines and any other content. Please use RequestHurryUpContent instead
public void RequestLineHurryUp()#RequestNextContent()
public void RequestNextContent()#RequestNextLine() Obsolete
Changes to the dialogue runner mean there is no longer a difference between skipping lines and any other content. Please use RequestNextContent instead
public void RequestNextLine()#RequestOptionHurryUp() Obsolete
Changes to the dialogue runner mean there is no longer a difference between hurrying up options and any other content. Please use RequestHurryUpContent instead
public void RequestOptionHurryUp()#RunCommand(Command, LineCancellationToken)
public override YarnTask RunCommand(Command command, LineCancellationToken cancellationToken)Parameters
commandYarn.CommandcancellationTokenYarn.Unity.LineCancellationToken
Returns YarnTask
#RunLineAsync(LocalizedLine, LineCancellationToken)
public override YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)Parameters
- The line to present.
- A LineCancellationToken that represents whether the dialogue presenter should hurry it its presentation of the line, or stop showing the current line.
Returns YarnTask: A completed task.
#RunOptionsAsync(DialogueOption[], LineCancellationToken)
public override YarnTask<DialogueOption?> RunOptionsAsync(DialogueOption[] dialogueOptions, LineCancellationToken cancellationToken)Parameters
dialogueOptionsYarn.Unity.DialogueOption[]cancellationTokenYarn.Unity.LineCancellationToken
Returns YarnTask: A completed task indicating that no option was selected by
this view.
Generated from Yarn Spinner for Unity 3.3.