Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

LineAdvancer

A dialogue presenter that listens for user input and sends requests to a DialogueRunner to advance the presentation of the current content, either by asking a dialogue runner to hurry up its delivery, advance to the next piece of content, or cancel the entire dialogue session.
public sealed class LineAdvancer : DialoguePresenterBase, IActionMarkupHandler

Inherits from Yarn.Unity.DialoguePresenterBase

Implements Yarn.Unity.IActionMarkupHandler

#Nested Types

  • The 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

Returns YarnTask

#OnDialogueCompleteAsync(CancellationToken)

Called by a dialogue runner when dialogue ends to remove the input action handlers.
public override YarnTask OnDialogueCompleteAsync(CancellationToken token)

Parameters

  • tokenCancellationToken

Returns YarnTask: A completed task.

#OnDialogueStartedAsync(CancellationToken)

Called by a dialogue runner when dialogue starts to add input action handlers for advancing the line.
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

#OnLineDisplayComplete()

public void OnLineDisplayComplete()

#OnLineWillDismiss()

public void OnLineWillDismiss()

#OnPrepareForLine(MarkupParseResult, TMP_Text)

public void OnPrepareForLine(MarkupParseResult line, TMP_Text text)

Parameters

#OnValidate()

public void OnValidate()

#RequestDialogueCancellation()

Requests that the dialogue runner to instruct all line views to dismiss their content, and then stops the dialogue.
public void RequestDialogueCancellation()

#RequestHurryUpContent()

Requests that the dialogue runner hurrys up the current piece of content.
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()

Requests that the dialogue runner proceeds to the next piece of content.
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

Requests that the dialogue runner proceeds to the next line.
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

Returns YarnTask

#RunLineAsync(LocalizedLine, LineCancellationToken)

Called by a dialogue presenter to signal that a line is running.
public override YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)

Parameters

Returns YarnTask: A completed task.

#RunOptionsAsync(DialogueOption[], LineCancellationToken)

Called by a dialogue presenter to signal that options are running.
public override YarnTask<DialogueOption?> RunOptionsAsync(DialogueOption[] dialogueOptions, LineCancellationToken cancellationToken)

Parameters

Returns YarnTask: A completed task indicating that no option was selected by this view.

Generated from Yarn Spinner for Unity 3.3.