Dialogue Editor

This is the technical documentation for the dialogue editor. It's used to create scenes with different camera angles, text and poses. It is commonly used to give context and progress the story in a level.

Before reading this article it's recommended that you read the Dialogue article to get a basic understanding of how dialogues work.

General Dialogue Functions

Set Dialogue Name

Command: #name "$"

Example: #name "chat_with_villager"

Sets the name of the current dialogue to whatever is written in $. This can be used by some other hotspots to start the dialogue.

Set Number of Participants

Command: #participants $

Example: #participants 3

Sets the number of participants in the dialogue to the number written in $.

Dialogue

Command: say # "n" "m"

Example: say 1 "Turner" "Hello, I am participant 1 in the dialogue and my name is Turner."

Makes participant # say m while the name tag shows n.

Waiting

Command: [wait 0.3]

Put in a say command.

Wait For Click

Command: [wait_for_click]

Put in a say command.

Name Tag Color

Command: set_dialogue_color # r g b

When the participant with number # says something, their name tag will have the color specified by the float values in r, g and b.

Voice

Command: set_dialogue_voice # i

In the menu bar of the dialogue editor, go to Edit → Preview Voice and click and drag through the slider to preview all the different voices.

Camera Position

Command: set_cam tx ty tz rx ry rz

Character Position

Command: set_character_pos # x y z r

Pose

Command: send_character_message # "set_animation \"$\""

Eye, Head & Torso Movement

Command: send_character_message # "$ x y z s"

 set_head_target
 set_torso_target
 set_eye_dir

Depth of Field

Command: send_level_message "set_camera_dof cs cd cg fs fd fg"

 cs = Close blur strength
 cd = Anything closer than this value will be blurred
 cg = How gradual the transition for close dof should be, 0 = infinite blur
 fs = Far blur strength
 fd = Anything further than this value will be blurred
 fg = How gradual the transition for far dof should be, 0 = infinite blur

Fade to Black

Command: fade_to_black i<code>

Can be set to 1 or 0. Going from fade_to_black 1 to fade_to_black 0 comes with some visual bugs.

Checkpoints

There are a few commands that can be used in dialogues to trigger checkpoints and things like that.

TODO: Should we list those functions here too?