> For the complete documentation index, see [llms.txt](https://espergames.gitbook.io/feel-speak/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://espergames.gitbook.io/feel-speak/scripting/dialogue-generation.md). # Dialogue Generation Generating dialogue graphs at runtime. Creating dialogue through code is straightforward once you understand the core methods. This tutorial walks you through building a dialogue graph step by step, showing how each piece of code corresponds to its representation in the dialogue graph editor. ## 1. Create a New Dialogue Graph Just use the `DialogueBuilder.New` method to create a new instance of a `DialogueGraph`. ```csharp DialogueGraph myDialogueGraph = DialogueBuilder.New(); ``` You can use this method to create new dialogue groups, characters, and emotions as well. At this point, we simply have an empty graph.
## 2. Add a Node Use the `Add` method to add any node to the graph. ```csharp Node myNode = myDialogueGraph.Add(); ``` Replace `Node` with one of the types below: * `DialogueNode` * `ChoiceNode` * `DelayNode` * `SoundNode` * `ActionNode` * `BooleanNode` * `NestNode` To start, we'll add a dialogue node: ```csharp DialogueNode myDialogueNode = myDialogueGraph.Add(); ```
The first node added is the starting node, however, you can change it by calling `SetAsStartingNode` on another node. ```csharp myNode.SetAsStartingNode(); ``` ## 3. Set the Properties After adding a node, set it's properties using the available methods. #### Dialogue Node You can set the dialogue, the character saying the dialogue, and the emotion with the `SetDialogue` method. ```csharp myDialogueNode.SetDialogue("My dialogue.", "My Character Name", "My Emotion Name"); ``` Localization is supported: 
myDialogueNode.SetDialogue(new List<Localization.LocaleString>()
{
    new("en", "Hello, world!"),
    new("es", "¡Hola, mundo!"),
    new("fr", "Bonjour le monde!"),
}, "My Character Name");
#### Choice Node The `AddChoices` method allows you to add any number of choices. Simply pass a pair of strings (choice name, and the display text) that represent the choices. ```csharp myChoiceNode.AddChoices(("Choice 1", "Yes"), ("Choice 2", "No")) ``` #### Delay Node Use `SetDelay` and pass a float that represents the number of seconds to delay the dialogue. 1f = 1s. ```csharp myDelayNode.SetDelay(1f) ``` #### Sound Node The `SetSound` method sets the sound that will be played. It requires a reference to an `AudioClip`. ```csharp mySoundNode.SetSound(myAudioClip) ``` #### Action Node You can set an action to execute with the `SetAction` method. ```csharp myActionNode.SetAction(() => Debug.Log("It worked!")); ``` #### Boolean Node The `SetCondition` method allows you to pass custom branching logic. The method must return `bool`. ```csharp bool isFeelSpeakCool = true; myBooleanNode.SetCondition(() => { return isFeelSpeakCool; }); ``` #### Nest Node To set nested dialogue, pass either a `DialogueGraph` or `DialogueGroup` in the `SetNestedDialogue` method. ```csharp myNestNode.SetNestedDialogue(dialogueGraphToNest); ``` ### Visual Representation For this example, we'll make a demo character, Pinky, say "Hello, world!". ```csharp myDialogueNode.SetDialogue("Hello, world!", "Pinky"); ```
## 4. Subsequent Additions The **next** node you add will **automatically** connect to the previous node. For this example, we'll add a choice node and add 2 choices. ```csharp ChoiceNode myChoiceNode = myDialogueGraph.Add(); myChoiceNode.AddChoices(("Choice 1", "Hello!"), ("Choice 2", "Hi!")) ```
## 5. Branching Choice and Boolean nodes both have multiple output ports, but automatic connections only use the first output port. This is where the `Branch` method comes into play. The `Branch` method creates a `Brancher` that you can use to use a specific output port of a node for the next added node. ```csharp myDialogueGraph.Branch(out Brancher brancher) // Create brancher .From(brancher.branches[0]) // Start branching from first choice (or first output port of the choice node) .Add().SetDialogue("You selected option 1!", "Pinky") // Add dialogue for option 1 .From(brancher.branches[1]) // Start branching from second choice .Add().SetDialogue("You selected option 2!", "Pinky") // Add dialogue for option 2 ```
Alternatively, you can use the `ConnectWith` method to connect with a specified node. ```csharp myFirstNode.ConnectWith(mySecondNode, 1); // Second parameter is the output port index ``` ## 6. Final Notes The above is all you really need to know to generate dialogue graphs at runtime. For the other node settings you can set from the node itself. For example: ```csharp myDialogueNode.automaticNextOnComplete = true; ``` The `ChoiceNode` has a method to help set the timeout: ```csharp myChoiceNode.SetTimeout(true, 10f); // Choice times out after 10s ``` ## Example Script The script below is used for the scripting demo. It requires the demo characters to be available as it generates dialogue with them. ```csharp /// /// Generates dialogue for the scripting demo scene. /// public class DialogueScriptingDemo : MonoBehaviour { public AudioClip audioClip; public GameObject structures; /// /// Generates dialogue with Pinky. /// public void GenerateDialogueWithPinky() { // Create a new dialogue graph var graph = DialogueBuilder.New(); // Create dialogue sequence graph.Add().SetDialogue("Hi, this dialogue was generated at runtime!", "Pinky") .Add().SetDialogue("Now let's test choices! Are you ready?", "Pinky") .Add().AddChoices(("Choice 1", "Yes"), ("Choice 2", "No")) .Branch(out Brancher branch1) .From(branch1.branches[0]) .Add().SetDialogue("You chose yes! Is that correct?", "Pinky") .Add().AddChoices(("Choice 1", "Yes"), ("Choice 2", "No")) .Branch(out Brancher branch2) .From(branch2.branches[0]) .Add().SetDialogue("I'm glad everything is working as intended!", "Pinky") .From(branch2.branches[1]) .Add().SetDialogue("Hmm... I guess something isn't working as intended.", "Pinky") .From(branch1.branches[1]) .Add().SetDialogue("You chose no!", "Pinky") .Merge(branch1.branches[1], branch2.branches[0], branch2.branches[1]).SetDialogue("All pathways lead here due to branch merging! Isn't that great?", "Pinky", "Happy") .Add().SetDialogue("Yeah, that's pretty cool.", "Robo"); // Start the dialogue (this uses the first dialogue box in the scene) DialogueBox.First.StartDialogue(graph); } /// /// Generates dialogue with Goldy. /// public void GenerateDialogueWithGoldy() { // Create a new dialogue graph var graph = DialogueBuilder.New(); // Create dialogue sequence graph.Add().SetDialogue("Alright, let's test some nodes.", "Goldy") .Add().AddChoices( ("Sound", "Sound Node"), ("Delay", "Delay Node"), ("Action", "Action Node"), ("Boolean", "Boolean Node"), ("Nest", "Nest Node"), ("Exit", "Exit")) .Branch(out Brancher brancher) .From(brancher.branches[0]) .Add().SetDialogue("Alright, let's play a sound.", "Goldy") .Add().SetSound(audioClip) .Add().SetDialogue("Did you hear that?", "Goldy") .ConnectWith(graph.choiceNodes[0]) .From(brancher.branches[1]) .Add().SetDialogue("Alright, let's delay the dialogue for 2 seconds.", "Goldy") .Add().SetDelay(2f) .Add().SetDialogue("And we're back!", "Goldy") .ConnectWith(graph.choiceNodes[0]) .From(brancher.branches[2]) .Add().SetDialogue("Alright, how about we toggle the structures?", "Goldy") .Add().SetAction(() => structures.SetActive(!structures.activeSelf)) .Add().SetDialogue("Neat, huh?", "Goldy") .ConnectWith(graph.choiceNodes[0]) .From(brancher.branches[3]) .Add().SetDialogue("Alright, a random number will be generated, 0 or 1. Based on the random number, the next dialogue will either be from me or Pinky.", "Goldy") .Add().SetCondition(() => { var random = Random.Range(0, 2); return random == 0; }) .Branch(out Brancher booleanBranch) .From(booleanBranch.branches[0]) .Add().SetDialogue("The number was 0!", "Goldy") .ConnectWith(graph.choiceNodes[0]) .From(booleanBranch.branches[1]) .Add().SetDialogue("The number was 1!", "Pinky") .ConnectWith(graph.choiceNodes[0]) .From(brancher.branches[4]) .Add().SetDialogue("Alright, how about we nest this dialogue within itself? Make sure to exit!", "Goldy") .Add().SetNestedDialogue(graph) .Add().SetDialogue("Welcome back!", "Goldy") .Add().SetDialogue("...", "Robo") .Add().SetDialogue("What?", "Goldy") .ConnectWith(graph.choiceNodes[0]) .From(brancher.branches[5]) .Add().SetDialogue("See ya!", "Goldy"); // Start the dialogue (this uses the first dialogue box in the scene) DialogueBox.First.StartDialogue(graph); } /// /// Generates some localized dialogue. /// public void GenerateDialogueLocalized() { // Create a new dialogue graph var graph = DialogueBuilder.New(); // Create localized dialogue sequence graph.Add().SetDialogue(new List() { new("en", "Hello, world!"), // English new("es", "¡Hola, mundo!"), // Spanish new("fr", "Bonjour le monde!"), // French }, "Pinky"); // Start the dialogue (this uses the first dialogue box in the scene) DialogueBox.First.StartDialogue(graph); } } ```