Method in LineAdvancer

Summary

Requests that the dialogue runner to instruct all line views to dismiss their content, and then stops the dialogue.

public void RequestDialogueCancellation()

Method in LineAdvancer

Summary

Called by a dialogue runner when dialogue ends to remove the input action handlers.

public override YarnTask OnDialogueCompleteAsync()

Returns

A completed task.

Field in LineAdvancer

Summary

If true , repeatedly signalling that the line should be hurried up will cause the line advancer to request that the next line be shown.

public bool multiAdvanceIsCancel = false;

See Also

• LineAdvancer.advanceRequestsBeforeCancellingLine: The number of times that a 'hurry up' signal occurs before the line advancer requests that the next line be shown.

Field in LineAdvancer

Summary

The number of times that a 'hurry up' signal occurs before the line advancer requests that the next line be shown.

public int advanceRequestsBeforeCancellingLine = 2;

See Also

• LineAdvancer.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.

Method in LineAdvancer

Summary

Called by a dialogue runner when dialogue starts to add input action handlers for advancing the line.

public override YarnTask OnDialogueStartedAsync()

Returns

A completed task.

Method in LineAdvancer

Summary

Requests that the dialogue runner proceeds to the next line.

public void RequestNextLine()

Method in LineAdvancer

Summary

Requests that the line be hurried up.

public void RequestLineHurryUp()

Remarks

If this method has been called more times for a single line than Yarn.Unity.LineAdvancer.numberOfAdvancesThisLine , this method requests that the dialogue runner proceed to the next line. Otherwise, it requests that the dialogue runner instruct all line views to hurry up their presentation of the current line.

Enumeration Member in InputMode

Summary

The line advancer responds to Input Actions from the Unity Input System .

InputActions

Enumeration Member in InputMode

Summary

The line advancer responds to input from the legacy Input Manager .

LegacyInputAxes

Enumeration Member in InputMode

Summary

The line advancer responds to keypresses on the keyboard.

KeyCodes

Enumeration Member in InputMode

Summary

The line advancer does not respond to any input.

None

Remarks

When a line advancer's Yarn.Unity.LineAdvancer.inputMode is set to None , call the RequestLineHurryUp() , RequestNextLine() and RequestDialogueCancellation() methods directly from your code to control line advancement.

Class in Yarn.Unity

Inherits from AsyncDialogueViewBase

Summary

A dialogue view 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 class LineAdvancer : AsyncDialogueViewBase

Enums

Fields

Methods

Enum in LineAdvancer

Inherits from System.Enum

Summary

The type of input that this line advancer responds to.

public enum InputMode
{
    InputActions,
    KeyCodes,
    None,
    LegacyInputAxes
}

Members

Method in LineAdvancer

Summary

Called by a dialogue view to signal that a line is running.

public override YarnTask RunLineAsync(LocalizedLine line, LineCancellationToken token)

Parameters

Returns

A completed task.

Method in

Summary

Called by a dialogue view to signal that options are running.

Parameters

Returns

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