DialogueUI.onCommand Field

A DialogueRunner.StringUnityEvent that is called when a Command is received.

public DialogueRunner.StringUnityEvent onCommand

Remarks

Use this method to dispatch a command to other parts of your game.

This method is only called if the Command has not been handled by a command handler that has been added to the DialogueRunner, or by a method on a MonoBehaviour in the scene with the attribute YarnCommandAttribute.

This method receives the full text of the command, as it appears between the << and >> markers.

See Also

• AddCommandHandler(String, DialogueRunner.CommandHandler): Adds a command handler. Dialogue will continue running after the command is called.

• AddCommandHandler(String, DialogueRunner.BlockingCommandHandler): Adds a command handler. Dialogue will pause execution after the command is called.

• YarnCommandAttribute: An attribute that marks a method on a MonoBehaviour as a command.

• DialogueRunner.StringUnityEvent: A type of UnityEvent that takes a single string parameter.

Source

Defined in Unity/Assets/YarnSpinner/Scripts/DialogueUI.cs, line 251.