RPG in a Box
Official Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======Dialogue Editor======
----

=====Overview=====
The **Dialogue Editor** is where you will create conversations for your game's characters or narration for scripted sequences and cutscenes. Dialogue can be attached to an NPC from its [[Entity Properties]] dialog in the [[Map Editor]] or triggered from a script using the [[Start Dialogue]] function.

=====File Toolbar=====
^Icon^Function^Description^
|{{:wiki:new_resource.png?nolink|}}|New Resource|Opens the [[New Resource dialog]] (with "Dialogue" selected for the resource type).|
|{{:wiki:disk.png?nolink|}}|Save|Saves changes to the dialogue.|
|{{:wiki:disk_multiple.png?nolink|}}|Save As|Saves a copy of the dialogue to a new file.|

=====Node Toolbar=====
The Node Toolbar is for adding new nodes to your dialogue. A node represents a specific point in the dialogue where an event occurs, for example when a character speaks, a message is displayed, a condition is evaluated, or a script is triggered. Clicking on one of these toolbar buttons will add a new node of that type to the center of the editor view.

{{:wiki:dialogue_editor_toolbar.png?nolink|}}

=====Dialogue Graph=====
The Dialogue Graph is the visual workspace where you will build your dialogue. Once you have added nodes to your dialogue, you can click and drag to move them around. To connect two nodes together, click and hold on the output connector of one then drag to the input connector of another and release. In order to have a valid dialogue, you need at least one node connected to the Start node. Nodes can be removed from the Dialogue Graph by clicking on their "X" button located in the upper right corner of the node.

{{:wiki:dialogue_graph.png?nolink|}}

=====Node Types=====
There are several different types of nodes that can be added to a dialogue graph. Refer to each section below for an explanation of that node type's purpose and any options that can be set.
<WRAP group>
<WRAP column 58%>
====NPC Node====
**NPC nodes** are for dialogue spoken by non-player characters (i.e. characters other than the player). Clicking the "Edit" button allows you to enter the text that will be displayed in the game's dialogue box when this node is reached.
\\
\\
The NPC's default portrait (as defined in the [[Voxel Editor]]) can be overridden for a specific node by selecting an image from the "Portrait" dropdown box. Selecting "None" will cause the portrait to be hidden.
\\
\\
The "Speaker" setting is used by the game to determine the name that is displayed for the speaker, along with its text color. Each setting is described in the table below.
</WRAP>
<WRAP column>
{{:wiki:npc_dialogue_node.png?nolink|}}
</WRAP>
</WRAP>
<WRAP group>
<WRAP column 70%>
^Speaker Setting^Description^
|Initiating NPC|Character from which the dialogue was started determines the speaker name and the text color.|
|Entity ID|Character having the specified entity ID determines the speaker name and the text color.|
|Custom Name|Speaker name is overridden with the specified text.|
|Custom Name/Color|Speaker name and its color are overridden with the specified name and text color.|
</WRAP>
<WRAP column>
{{:wiki:dialogue_speaker_example.png?nolink|}}
</WRAP>
</WRAP>
\\
<WRAP group>
<WRAP column 58%>
====Player Node====
**Player nodes** are for dialogue spoken by the player character. Clicking the "Edit" button allows you to enter the text that will be displayed in the game's dialogue box when this node is reached.
\\
\\
The player's default portrait (as defined in the [[Voxel Editor]]) can be overridden for a specific node by selecting an image from the "Portrait" dropdown box. Selecting "None" will cause the portrait to be hidden.
</WRAP>
<WRAP column>
{{:wiki:player_dialogue_node.png?nolink|}}
</WRAP>
</WRAP>
<WRAP center round info 100%>
You can connect more than one "Player" node to the output connector of another node. Doing so will provide the player with a list of responses to choose from and allow the dialogue to be branched based upon the player's response.
</WRAP>
\\
<WRAP group>
<WRAP column 58%>
====Message Node====
**Message nodes** are used to display any general text that is not spoken by a character, for example to describe an event that is occurring in the scene.
\\
\\
Clicking the "Edit" button allows you to enter the text that will be displayed in the game's dialogue box when this node is reached. This is similar to using the [[Display Message]] function in a script.
</WRAP>
<WRAP column>
{{:wiki:message_dialogue_node.png?nolink|}}
</WRAP>
</WRAP>
\\
<WRAP group>
<WRAP column 58%>
====Condition Node====
**Condition nodes** provide a way of branching the dialogue based on the results of a conditional expression being evaluated.
\\
\\
Clicking the "Edit" button opens the [[Conditional Expression Builder]], allowing you to define the conditional expression that will be evaluated when this node is reached. If the condition is met (i.e. evaluates to true), then the dialogue will proceed to the node connected to the "Then" output connector. Otherwise, it will proceed to the node connected to the "Else" output connector.
</WRAP>
<WRAP column>
{{:wiki:condition_dialogue_node.png?nolink|}}
</WRAP>
</WRAP>
\\
<WRAP group>
<WRAP column 58%>
====Script Node====
**Script nodes** provide a way to trigger scripts during the dialogue, for example to give an item to the player or move the camera to a different viewpoint. You can choose between either a "Quick Script" or a "Resource" (i.e. an existing script file). If the "Quick Script" option is selected, clicking the "Build" button will open the [[Quick Script Builder]].
\\
\\
The "Pause until complete" checkbox determines whether or not the dialogue will wait for the script to complete before proceeding. For example, if the script includes a timed camera movement and "Pause until complete" is checked, the dialogue will not proceed until the camera movement has finished.
</WRAP>
<WRAP column>
{{:wiki:script_dialogue_node.png?nolink|}}
</WRAP>
</WRAP>

~~NOTOC~~
RPG in a BoxOfficial Documentation

User Tools

Site Tools

Page Tools

RPG in a Box
Official Documentation
