OnDialogueStartedAsync()

Method in AsyncDialogueViewBase

Summary

Called by the DialogueRunner to signal that dialogue has started.

public abstract YarnTask OnDialogueStartedAsync();

Remarks

This method is called before any content (that is, lines, options or commands) are delivered.

This method is a good place to perform tasks like preparing on-screen dialogue UI (for example, turning on a letterboxing effect, or making dialogue UI elements visible.)

The default implementation of this method does nothing.

Returns

A task that represents any work done by this dialogue view in order to get ready for dialogue to run.

Last updated

Yarn Spinner® and Secret Lab® are trade marks of Secret Lab Pty. Ltd., and are used by Yarn Spinner Pty. Ltd. under license.