DialogueUIBehaviour Class
A MonoBehaviour that can display lines, options and commands to the user, and receive input regarding their choices.
public abstract class DialogueUIBehaviour : MonoBehaviour
Remarks
The DialogueRunner uses subclasses of this type to relay information to and from the user, and to pause and resume the execution of the Yarn program.
Methods
| Name | Description |
|---|---|
| DialogueComplete() | Called by the DialogueRunner to signal that the dialogue has ended. |
| DialogueStarted() | Signals that a conversation has started. |
| NodeComplete(String, Action) | Called by the DialogueRunner to signal that the end of a node has been reached. |
| RunCommand(Command, Action) | Called by the DialogueRunner to signal that a command should be executed. |
| RunLine(Line, ILineLocalisationProvider, Action) | Called by the DialogueRunner to signal that a line should be displayed to the user. |
| RunOptions(OptionSet, ILineLocalisationProvider, Action |
Called by the DialogueRunner to signal that a set of options should be displayed to the user. |
See Also
-
dialogueUI: The object that will handle the actual display and user input. -
DialogueUI: Displays dialogue lines to the player, and sends user choices back to the dialogue system.
Source
Defined in Unity/Assets/YarnSpinner/Scripts/DialogueRunner.cs, line 1072.