[Editor] Expose more editor settings to documentation #93427

AThousandShips · 2024-06-21T10:57:21Z

Found quite a few editor settings that weren't declared in a way that allowed the doctool to find them. Haven't fully confirmed that moving these won't break anything, but it shouldn't.

Needing some help with the description for a number of the settings as I don't know what they do, but I've tried to fill them in as best I could.

Some of the settings I left where they were and added a comment, as I didn't know how to move them without possibly breaking them

The settings were copied over as closely as possible, converting to _initial_set and similar, should match correctly (I'm not 100% sure on the exact syntax to use in each case)

AThousandShips · 2024-06-21T10:57:42Z

editor/editor_settings.cpp

@@ -562,6 +568,10 @@ void EditorSettings::_load_defaults(Ref<ConfigFile> p_extra_config) {
 	_initial_set("filesystem/on_save/compress_binary_resources", true);
 	_initial_set("filesystem/on_save/safe_save_on_backup_then_rename", true);

+	// File server
+	_initial_set("filesystem/file_server/port", 6010);


Should this have a range?

Yes but with no_slider.

Yeah there should probably be a range if there's a min and max for valid ports. I looked through the code a bit and we don't seem to do any validation for the port range currently in EditorFileServer/TCPServer/NetSocketPosix before passing it to the OS APIs.

CC @Faless @mhilbrunner

AThousandShips · 2024-06-21T10:57:51Z

editor/editor_settings.cpp


 	// Script list
 	_initial_set("text_editor/script_list/show_members_overview", true);
 	_initial_set("text_editor/script_list/sort_members_outline_alphabetically", false);
+	_initial_set("text_editor/script_list/script_temperature_enabled", true);
+	_initial_set("text_editor/script_list/script_temperature_history_size", 15);


Should this have a range?

I wouldn't bother here, unless very high numbers brick the editor.

AThousandShips · 2024-06-21T10:58:04Z

editor/editor_settings.cpp

+	EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/skeleton", Color(1, 0.8, 0.4), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
+	EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/selected_bone", Color(0.8, 0.3, 0.0), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
+	EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/csg", Color(0.0, 0.4, 1, 0.15), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
+	_initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);


Should this have a range?

AThousandShips · 2024-06-21T10:58:12Z

editor/editor_settings.cpp

+	EDITOR_SETTING_USAGE(Variant::COLOR, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_colors/csg", Color(0.0, 0.4, 1, 0.15), "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)
+	_initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);
+	EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d_gizmos/gizmo_settings/bone_shape", 1, "Wire,Octahedron");
+	EDITOR_SETTING_USAGE(Variant::FLOAT, PROPERTY_HINT_NONE, "editors/3d_gizmos/gizmo_settings/path3d_tilt_disk_size", 0.8, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_RESTART_IF_CHANGED)


Should this have a range?

AThousandShips · 2024-06-21T10:58:25Z

editor/editor_settings.cpp

+	_initial_set("editors/grid_map/palette_min_width", 230);
+	_initial_set("editors/grid_map/preview_size", 64);


Should these have ranges?

AThousandShips · 2024-06-21T10:59:56Z

doc/classes/EditorSettings.xml

+			The path to the text editor executable used to edit text files if [member text_editor/external/use_external_editor] is [code]true[/code].
+		</member>
+		<member name="text_editor/external/use_external_editor" type="bool" setter="" getter="">
+			If [code]true[/code] opens an external editor instead of the built-in script editor. See also [member text_editor/external/exec_path] and [member text_editor/external/exec_flags].


Depending on the desired behavior from:

The built-in script editor opens scripts in external editor #93415

This might need clarification

AThousandShips · 2024-06-21T11:12:43Z

editor/scene_tree_dock.cpp

@@ -4596,9 +4596,6 @@ SceneTreeDock::SceneTreeDock(Node *p_scene_root, EditorSelection *p_editor_selec
 	set_process_input(true);
 	set_process(true);

-	EDITOR_DEF("interface/editors/show_scene_tree_root_selection", true);
-	EDITOR_DEF("interface/editors/derive_script_globals_by_name", true);
-	EDITOR_DEF("docks/scene_tree/ask_before_deleting_related_animation_tracks", true);
 	EDITOR_DEF("_use_favorites_root_selection", false);


Left this as it looks internal

AThousandShips · 2024-06-21T11:30:39Z

editor/editor_settings.cpp

+	_initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);
+	EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d_gizmos/gizmo_settings/bone_shape", 1, "Wire,Octahedron");


Should these be restart required? Don't know how they work

editor/editor_settings.cpp

doc/classes/EditorSettings.xml

editor/export/editor_export_plugin.cpp

KoBeWi · 2024-06-21T14:28:02Z

As I once mentioned in godotengine/godot-proposals#4771 (comment), I think it might be better to find a way to define properties in where they belong, but still allow doctools to find them.

Though the current solution, for the sake of exposing the properties to documentation, is fine for now.

Mickeon

My reviews above still stand, unless you disagree intentionally of course.

AThousandShips · 2024-08-27T12:57:01Z

Will go over them, just pushed to fix conflicts

Mickeon

Some of these descriptions still need to be filled but I wouldn't spend further time on this current PR doing that.

doc/classes/EditorSettings.xml

dalexeev · 2024-09-06T09:02:22Z

modules/gdscript/editor/gdscript_highlighter.cpp

@@ -852,6 +852,7 @@ void GDScriptSyntaxHighlighter::_update_cache() {
 		comment_marker_colors[COMMENT_MARKER_NOTICE] = Color(0.24, 0.54, 0.09);
 	}

+	// TODO: Move to editor_settings.cpp


See Editor: Document comment marker editor settings #96566 (only text_editor/theme/highlighting/comment_markers/*).

AThousandShips · 2024-09-06T10:16:22Z

Will add the last suggestions later today and some of the descriptions can be elaborated on in future dedicated PRs by people with specific knowledge

editor/editor_settings.cpp

Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>

akien-mga

Let's merge this as a good first step, and we can iterate further on adding ranges or improving descriptions in later PRs.

akien-mga · 2024-09-13T09:29:13Z

Thanks!

AThousandShips · 2024-09-13T09:30:04Z

Thank you!

AThousandShips added bug enhancement topic:editor documentation labels Jun 21, 2024

AThousandShips added this to the 4.3 milestone Jun 21, 2024

AThousandShips requested review from a team as code owners June 21, 2024 10:57

AThousandShips commented Jun 21, 2024

View reviewed changes

editor/editor_settings.cpp Show resolved Hide resolved

AThousandShips commented Jun 21, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

KoBeWi reviewed Jun 21, 2024

View reviewed changes

editor/export/editor_export_plugin.cpp Outdated Show resolved Hide resolved

AThousandShips added this to the 4.4 milestone Jul 7, 2024

AThousandShips force-pushed the editor_setting_doc branch from bdee77b to 4c44f91 Compare July 17, 2024 10:24

AThousandShips force-pushed the editor_setting_doc branch from 4c44f91 to 0544022 Compare August 16, 2024 17:58

AThousandShips force-pushed the editor_setting_doc branch from 0544022 to 3a1aa56 Compare August 27, 2024 10:45

Mickeon reviewed Aug 27, 2024

View reviewed changes

AThousandShips force-pushed the editor_setting_doc branch 2 times, most recently from b024e76 to cd6e0a8 Compare September 5, 2024 16:16

akien-mga requested a review from Calinou September 5, 2024 17:30

Mickeon approved these changes Sep 5, 2024

View reviewed changes

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

Calinou reviewed Sep 5, 2024

View reviewed changes

doc/classes/EditorSettings.xml Outdated Show resolved Hide resolved

dalexeev reviewed Sep 6, 2024

View reviewed changes

AThousandShips force-pushed the editor_setting_doc branch 3 times, most recently from 8d0fcd0 to abf0b65 Compare September 9, 2024 16:34

akien-mga reviewed Sep 10, 2024

View reviewed changes

editor/editor_settings.cpp Outdated Show resolved Hide resolved

[Editor] Expose more editor settings to documentation

dd64431

Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>

AThousandShips force-pushed the editor_setting_doc branch from abf0b65 to dd64431 Compare September 12, 2024 13:35

akien-mga approved these changes Sep 13, 2024

View reviewed changes

akien-mga merged commit 04456cf into godotengine:master Sep 13, 2024
20 checks passed

AThousandShips deleted the editor_setting_doc branch September 13, 2024 09:29

L4Vo5 mentioned this pull request Sep 25, 2024

Add option to sort script list by last opened #83608

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Editor] Expose more editor settings to documentation #93427

[Editor] Expose more editor settings to documentation #93427

AThousandShips commented Jun 21, 2024 •

edited

Loading

AThousandShips Jun 21, 2024

Mickeon Jun 21, 2024

akien-mga Sep 10, 2024

AThousandShips Jun 21, 2024

akien-mga Sep 10, 2024 •

edited

Loading

AThousandShips Jun 21, 2024

AThousandShips Jun 21, 2024

AThousandShips Jun 21, 2024

AThousandShips Jun 21, 2024

AThousandShips Jun 21, 2024

AThousandShips Jun 21, 2024

KoBeWi commented Jun 21, 2024

Mickeon left a comment

AThousandShips commented Aug 27, 2024

Mickeon left a comment

dalexeev Sep 6, 2024

AThousandShips commented Sep 6, 2024

akien-mga left a comment

akien-mga commented Sep 13, 2024

AThousandShips commented Sep 13, 2024

		_initial_set("editors/grid_map/palette_min_width", 230);
		_initial_set("editors/grid_map/preview_size", 64);

		_initial_set("editors/3d_gizmos/gizmo_settings/bone_axis_length", (float)0.1);
		EDITOR_SETTING(Variant::INT, PROPERTY_HINT_ENUM, "editors/3d_gizmos/gizmo_settings/bone_shape", 1, "Wire,Octahedron");

[Editor] Expose more editor settings to documentation #93427

[Editor] Expose more editor settings to documentation #93427

Conversation

AThousandShips commented Jun 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

akien-mga Sep 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KoBeWi commented Jun 21, 2024

Mickeon left a comment

Choose a reason for hiding this comment

AThousandShips commented Aug 27, 2024

Mickeon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AThousandShips commented Sep 6, 2024

akien-mga left a comment

Choose a reason for hiding this comment

akien-mga commented Sep 13, 2024

AThousandShips commented Sep 13, 2024

AThousandShips commented Jun 21, 2024 •

edited

Loading

akien-mga Sep 10, 2024 •

edited

Loading