OptionsPresenter.RunOptionsAsync(DialogueOption[],LineCancellationToken)

Method in OptionsPresenter

Summary

Called by a DialogueRunner to display a collection of options to the user.

public override async YarnTask<DialogueOption?> RunOptionsAsync(DialogueOption[] dialogueOptions, LineCancellationToken cancellationToken)

Parameters

NameDescription
Yarn.Unity.DialogueOption[] dialogueOptionsThe set of options that should be displayed to the user.
Yarn.Unity.LineCancellationToken cancellationTokenA System.Threading.CancellationToken that becomes cancelled when the dialogue runner no longer needs this dialogue presenter to return an option.

Returns

A task that indicates which option was selected, or that this dialogue presenter did not select an option.