Browse Source

Merge pull request #46386 from KoBeWi/projekt_settingz

Clarify ProjectSettings.save for exported projects
Rémi Verschelde 4 years ago
parent
commit
afd0df7921
2 changed files with 3 additions and 2 deletions
  1. 1 1
      core/config/project_settings.cpp
  2. 2 1
      doc/classes/ProjectSettings.xml

+ 1 - 1
core/config/project_settings.cpp

@@ -909,7 +909,7 @@ Error ProjectSettings::save_custom(const String &p_path, const CustomMap &p_cust
 		custom_features += f;
 	}
 
-	if (p_path.ends_with(".godot")) {
+	if (p_path.ends_with(".godot") || p_path.ends_with("override.cfg")) {
 		return _save_settings_text(p_path, props, p_custom, custom_features);
 	} else if (p_path.ends_with(".binary")) {
 		return _save_settings_binary(p_path, props, p_custom, custom_features);

+ 2 - 1
doc/classes/ProjectSettings.xml

@@ -169,6 +169,7 @@
 			</return>
 			<description>
 				Saves the configuration to the [code]project.godot[/code] file.
+				[b]Note:[/b] This method is intended to be used by editor plugins, as modified [ProjectSettings] can't be loaded back in the running app. If you want to change project settings in exported projects, use [method save_custom] to save [code]override.cfg[/code] file.
 			</description>
 		</method>
 		<method name="save_custom">
@@ -177,7 +178,7 @@
 			<argument index="0" name="file" type="String">
 			</argument>
 			<description>
-				Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format).
+				Saves the configuration to a custom file. The file extension must be [code].godot[/code] (to save in text-based [ConfigFile] format) or [code].binary[/code] (to save in binary format). You can also save [code]override.cfg[/code] file, which is also text, but can be used in exported projects unlike other formats.
 			</description>
 		</method>
 		<method name="set_initial_value">