ActionRegistrationExtension.AddCommandHandler(IActionRegistration,string,System.Action)

Method in ActionRegistrationExtension

Summary

Adds a command handler. Dialogue will pause execution after the command is called.

public static void AddCommandHandler(this IActionRegistration registration, string commandName, System.Action handler);

Remarks

When this command handler has been added, it can be called from your Yarn scripts like so:

<<commandName param1 param2>>

If handler is a method that returns a UnityEngine.Coroutine, when the command is run, the DialogueRunner will wait for the returned coroutine to stop before delivering any more content.

If handler is a method that returns an System.Collections.IEnumerator, when the command is run, the DialogueRunner will start a coroutine using that method and wait for that coroutine to stop before delivering any more content.

Parameters

NameDescription
string commandNameThe name of the command.
Action handlerThe CommandHandler that will be invoked when the command is called.
Yarn.Unity.IActionRegistration registration