summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2020-09-01 19:18:45 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2020-09-01 19:19:25 +0200
commit386f86cddfff7265adb27f4524f027f57553a776 (patch)
tree19413dfe55f19855494ccb1afc47c9f74f4c0103 /doc/classes
parent64e0a129001b670a81ffa833aa85d8ed7bc73d39 (diff)
Document how renaming the project affects the user data path
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/ProjectSettings.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml
index f1feade59d..8614042646 100644
--- a/doc/classes/ProjectSettings.xml
+++ b/doc/classes/ProjectSettings.xml
@@ -205,7 +205,8 @@
Icon set in [code].icns[/code] format used on macOS to set the game's icon. This is done automatically on start by calling [method DisplayServer.set_native_icon].
</member>
<member name="application/config/name" type="String" setter="" getter="" default="&quot;&quot;">
- The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files.
+ The project's name. It is used both by the Project Manager and by exporters. The project name can be translated by translating its value in localization files. The window title will be set to match the project name automatically on startup.
+ [b]Note:[/b] Changing this value will also change the user data folder's path if [member application/config/use_custom_user_dir] is [code]false[/code]. After renaming the project, you will no longer be able to access existing data in [code]user://[/code] unless you rename the old folder to match the new project name. See [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] in the documentation for more information.
</member>
<member name="application/config/project_settings_override" type="String" setter="" getter="" default="&quot;&quot;">
Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code].