Two core concepts of this system are dialogue nodes and interpreters.
Dialogue is composed with dialogue nodes in a scene tab and later executed via interpreter in a script.
Base class: DialogueNodeBase.
Every node has:
start_dialoguemethod
Used for starting interpreter with dialogue data. Must be redefined in a derived class.
interpreteraccessor
Access node's Interpreter property. If property is not set in the editor, accessor will attempt to find an interpreter above in a node tree. If none is found, prints an error.
Interpreterproperty
Class: DialoguePhrase.
Dialogue node with name and text multiline properties.
When executed via start_dialogue, will run say method of an interpreter with phrase name and text.
Class: DialogueQuestion.
Dialogue node with question and options properties.
When executed via start_dialogue, will run ask method of an interpreter with question text and options texts array.
ask method must return index of choosen question option.
option is a DialogueQuestionOption custom resource with text and path node path, used for alter dialogue execution path.
Class: DialogueQuestionOption.
Class: DialogueGroup.
Dialogue node used for grouping other nodes.
When executed via start_dialogue, will run start_dialogue of each of it's children sequentially.
Children's start_dialogue can return node path of another dialogue node, and it's start_dialogue will be executed in a sequence as well. This behaviour provides a way to change a way of dialogue execution through question dialogue node, for example.
Base node: DialogueInterpreterBase.
Every derived node must redefine:
say(name: String, text: String)
Used when executing Phrase dialogue node.
ask(question: String, options: Array[String]) -> int
Used when executing Question dialogue node.
Must return index of options from options array.
Scene: dialogue_example.tscn.
Example interpreters:
-
DialogueInterpreterConsolefor printing in a console -
DialogueInterpreterUIfor ui-based dialogue.