Dialogue Editor - Revision history

Constance: /* Camera Position */ Included information about a minor bug.

2022-07-12T21:12:12Z

Camera Position: Included information about a minor bug.

← Older revision		Revision as of 14:12, 12 July 2022
Line 68:		Line 68:

	However, in some cases it can be very useful to be able to copy a <code>set_cam</code> line from one place to another and things like that.		However, in some cases it can be very useful to be able to copy a <code>set_cam</code> line from one place to another and things like that.

			Sometimes, adjusting things in a line of dialogue will extraneously add another <code>set_cam</code> line. You'll want to remove this in order to maintain a steady camera.

	=== Character Position ===		=== Character Position ===

Constance: /* Pose */ Included information about two bugs related to the Load Pose function.

2022-07-12T21:07:58Z

Pose: Included information about two bugs related to the Load Pose function.

← Older revision		Revision as of 14:07, 12 July 2022
Line 96:		Line 96:

	All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.		All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.

			There are two bugs you should watch out for:

			* '''There is a very, very troubling bug that you need to be wary of:''' If you click Load Pose, there's a small chance there will be two browser windows. If this happens, close both and try again. Otherwise, the dialogue editor will become non-functional.
			* If the <code>set_animation</code> field points to an incorrect or incomplete path, the game will crash. If you need to type the animation path, you should copy and paste the path manually instead of typing.

	=== Eye, Head & Torso Movement ===		=== Eye, Head & Torso Movement ===

Constance: /* Character Position */ Included details about the duplication bug

2022-07-12T20:54:32Z

Character Position: Included details about the duplication bug

← Older revision		Revision as of 13:54, 12 July 2022
Line 79:		Line 79:

	Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.		Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.

			'''There's a minor bug that you need to watch out for: Sometimes, adjusting things in a new line of dialogue will extraneously add another <code>set_character_pos</code> line. You'll want to remove this duplicate line, as it will interrupt animation blending.'''

	=== Pose ===		=== Pose ===

Mng: /* Depth of Field */ Added Note.

2018-06-16T08:07:38Z

Depth of Field: Added Note.

← Older revision		Revision as of 01:07, 16 June 2018
Line 110:		Line 110:

	Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>		Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>

			'''NOTE:''' The player character needs to be connected to the dialogue for it to work.

	* cs = Close blur strength		* cs = Close blur strength

Mng: Added to category: Modding, Overgrowth

2018-03-08T17:49:20Z

Added to category: Modding, Overgrowth

← Older revision		Revision as of 10:49, 8 March 2018
Line 126:		Line 126:

	<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.		<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.

			[[Category: Overgrowth]]
			[[Category: Modding]]

Silverfish: added todo

2018-02-19T09:41:26Z

added todo

← Older revision		Revision as of 02:41, 19 February 2018
Line 1:		Line 1:
			'''TODO: Figure out how to best cover all the missing send_level_message and send_character_message commands.'''

	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.		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.

Silverfish: /* Checkpoints */ removed heading and contents

2018-01-31T10:20:17Z

Checkpoints: removed heading and contents

← Older revision		Revision as of 03:20, 31 January 2018
Line 124:		Line 124:

	<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.		<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.

	~~== 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?'''~~

Silverfish: /* Character Position */ Fixed link

2018-01-31T10:18:02Z

Character Position: Fixed link

← Older revision		Revision as of 03:18, 31 January 2018
Line 74:		Line 74:
	Sets the location of participant <code>#</code> to <code>x, y, z</code>, and rotates them around the vertical axis <code>r</code> degrees.		Sets the location of participant <code>#</code> to <code>x, y, z</code>, and rotates them around the vertical axis <code>r</code> degrees.

	Just like with [#Camera_Position\|camera positions] you don't need to manually set character positions in the script since the appropriate line of code will be automatically generated when you move one of the character position boxes that can be found by default on each participant's spawn box. As with camera positions, you need to make sure to select the <code>say</code> line that you want to edit before making any changes.		Just like with [[#Camera_Position\|camera positions]] you don't need to manually set character positions in the script since the appropriate line of code will be automatically generated when you move one of the character position boxes that can be found by default on each participant's spawn box. As with camera positions, you need to make sure to select the <code>say</code> line that you want to edit before making any changes.

	Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.		Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.

Silverfish: Added some more info and fixed some issues

2018-01-31T09:42:55Z

Added some more info and fixed some issues

← Older revision		Revision as of 02:42, 31 January 2018
Line 87:		Line 87:
	You don't have to write this line manually because it can be generated for you if you do the following:		You don't have to write this line manually because it can be generated for you if you do the following:

	#. Click on the <code>say</code> line in the dialogue that you want the animation to play for		# Click on the <code>say</code> line in the dialogue that you want the animation to play for
	#. Select the dialogue character position box in the 3D view for the character you want to play an animation		# Select the dialogue character position box in the 3D view for the character you want to play an animation
	#. In the dialogue editor's menu bar, press ''File → Load Pose'' and load the animation you want		# In the dialogue editor's menu bar, press ''File → Load Pose'' and load the animation you want

	All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.		All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.
Line 109:		Line 109:
	Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>		Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>

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

			The depth of field is split into two parts with three parts in each, the close blur and the far blur. First in each part is how strong the blur should be (<code>xs</code>), then at what distance it should end/start (<code>xd</code>), and then how long the transition from/to the blur should be (<code>cg</code>).

	=== Fade to Black ===		=== Fade to Black ===
	Command: <code>fade_to_black $<code>		Command: <code>fade_to_black $</code>

			Example: <code>fade_to_black 1</code>

	<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.		<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.

Silverfish: Added how to use each command

2018-01-31T09:38:33Z

Added how to use each command

← Older revision		Revision as of 02:38, 31 January 2018
Line 27:		Line 27:

	=== Waiting ===		=== Waiting ===
	Command: <code>[wait ~~0.3~~]</code>		Command: <code>[wait $]</code>

	Put in a say command.		Example: <code>say 1 "Turner" "Hmm... [wait 0.5]I should eat some carrots!"</code>

			Put somewhere in the middle of a say command to pause the text printing for <code>$</code> seconds.

	=== Wait For Click ===		=== Wait For Click ===
	Command: <code>[wait_for_click]</code>		Command: <code>[wait_for_click]</code>

	Put in a say command.		Example: <code>say 1 "Turner" "But why!? [wait_for_click]Why did you burn all the lettuce!?"</code>

			Put somewhere in the middle of a say command to pause the text printing until the player left clicks.

	=== Name Tag Color ===		=== Name Tag Color ===
	Command: <code>set_dialogue_color # r g b</code>		Command: <code>set_dialogue_color # r g b</code>

	When ~~the~~ participant ~~with number~~ # says something, their name tag will have the color specified by the float values in r, g ~~and~~ b.		Example: <code>set_dialogue_color 2 0.8 0 0.8</code>

			When participant <code>#</code> says something, their name tag will have the color specified by the float values in <code>r, g, b</code> (red, green, blue).

	=== Voice ===		=== Voice ===
	Command: <code>set_dialogue_voice # i</code>		Command: <code>set_dialogue_voice # i</code>

	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.		Example: <code>set_dialogue_voice 2 8</code>

			Sets the voice of participant <code>#</code> to <code>i</code>.

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

	=== Camera Position ===		=== Camera Position ===
	Command: <code>set_cam tx ty tz rx ry rz</code>		Command: <code>set_cam tx ty tz rx ry rz</code>

			Example: <code>set_cam 5.0 3.1 2.5 0.0 0.0 0.0</code>

			Sets the location of the camera for the next <code>say</code> command to <code>tx, ty, tz</code> (translation x, y, z), and sets the rotation to <code>rx, ry, rz</code> (rotation x, y, z).

			You don't need to set this manually in the script because this line will be generated automatically when you move the camera object that is located on the dialogue hotspot by default when editing a dialogue. Keep in mind that when you do this you need to first select the <code>say</code> command in the script that you want to change the camera angle for, as the <code>set_cam</code> line will be put before that line.

			However, in some cases it can be very useful to be able to copy a <code>set_cam</code> line from one place to another and things like that.

	=== Character Position ===		=== Character Position ===
	Command: <code>set_character_pos # x y z r</code>		Command: <code>set_character_pos # x y z r</code>

			Example: <code>set_character_pos 1 3.0 0.0 5.0 30</code>

			Sets the location of participant <code>#</code> to <code>x, y, z</code>, and rotates them around the vertical axis <code>r</code> degrees.

			Just like with [#Camera_Position\|camera positions] you don't need to manually set character positions in the script since the appropriate line of code will be automatically generated when you move one of the character position boxes that can be found by default on each participant's spawn box. As with camera positions, you need to make sure to select the <code>say</code> line that you want to edit before making any changes.

			Copying and pasting <code>set_character_pos</code> lines can be useful to reuse positions in cutscenes without having to set them up again.

	=== Pose ===		=== Pose ===
	Command: <code>send_character_message # "set_animation \"$\""</code>		Command: <code>send_character_message # "set_animation \"$\""</code>

			Example: <code>send_character_message 1 "set_animation \"Data/Animations/r_dialogue_shade.anm\""</code>

			Makes participant <code>#</code> play the animation at <code>$</code>. Note that we're using ''\"'' to "escape" the <code>"</code> characters.

			You don't have to write this line manually because it can be generated for you if you do the following:

			#. Click on the <code>say</code> line in the dialogue that you want the animation to play for
			#. Select the dialogue character position box in the 3D view for the character you want to play an animation
			#. In the dialogue editor's menu bar, press ''File → Load Pose'' and load the animation you want

			All animations can be found in the ''../Overgrowth/Data/Animations/'' folder.

	=== Eye, Head & Torso Movement ===		=== Eye, Head & Torso Movement ===
	Command: <code>send_character_message # "$ x y z s"</code>		Command: <code>send_character_message # "$ x y z i"</code>

	set_head_target		Example: <code>send_character_message 2 "set_head_target 5.0 3.2 1.1 0.8"</code>
	set_torso_target
	~~set_eye_dir~~		Makes participant <code>#</code> turn their <code>$</code> towards location <code>x, y, z</code>, with the influence <code>i</code>. If <code>i</code> is <code>1</code>, it will face as much towards <code>x, y, z</code> as possible, and if it's 0 the command has no effect.

			<code>$</code> Can be set to <code>set_head_target</code> or <code>set_torso_target</code>. <code>set_eye_dir</code> used to work, but currently dosn't.

			This command doesn't need to be written manually, because it will be automatically set for the currently selected <code>say</code> line when you move one of the eye, head or torso targets. Scale the targets to change the influence.

	=== Depth of Field ===		=== Depth of Field ===
	Command: <code>send_level_message "set_camera_dof cs cd cg fs fd fg"</code>		Command: <code>send_level_message "set_camera_dof cs cd cg fs fd fg"</code>

	cs = Close blur strength		Example: <code>send_level_message "set_camera_dof 0.3 5.0 10.0 0.3 20.0 10.0"</code>
	cd = Anything closer than this value will be blurred
	cg = How gradual the transition for close dof should be, 0 = infinite blur		cs = Close blur strength
	fs = Far blur strength		cd = Anything closer than this value will be blurred
	fd = Anything further than this value will be blurred		cg = How gradual the transition for close dof should be, 0 = infinite blur
	fg = How gradual the transition for far 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 ===		=== Fade to Black ===
	Command: <code>fade_to_black i<code>		Command: <code>fade_to_black $<code>

	~~Can~~ be set to 1 ~~or 0~~. ~~Going from fade_to_black 1~~ to ~~fade_to_black~~ 0 ~~comes with~~ some visual bugs.		<code>$</code> can be set to 1 to make the view fade to black on the next <code>say</code> command. If you set it to 0 afterwards, you get some visual bugs in the dialogue.

	== Checkpoints ==		== Checkpoints ==