This site is for Yarn Spinner v1, and won't be updated. Go to the current site.

DialogueUIBehaviour.RunCommand Method

Called by the DialogueRunner to signal that a command should be executed.

public abstract Dialogue.HandlerExecutionType RunCommand(Command command, Action onCommandComplete)

Remarks

This method will only be invoked if the Command could not be handled by the DialogueRunner.

If this method returns ContinueExecution, it should not call the onCommandComplete method.

Parameters

Parameter Description
Command command The command to be executed.
Action onCommandComplete A method that should be called to indicate that the DialogueRunner should continue execution.

Return Type

Dialogue.HandlerExecutionType: PauseExecution if dialogue should wait until the completion handler is called before continuing execution; ContinueExecution if dialogue should immediately continue running after calling this method.

Source

Defined in Unity/Assets/YarnSpinner/Scripts/DialogueRunner.cs, line 1137.