Document how renaming the project affects the user data path

This commit is contained in:
Hugo Locurcio 2020-09-01 19:18:45 +02:00
parent 64e0a12900
commit 386f86cddf
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C

View file

@ -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]. 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>
<member name="application/config/name" type="String" setter="" getter="" default="&quot;&quot;"> <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>
<member name="application/config/project_settings_override" type="String" setter="" getter="" default="&quot;&quot;"> <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]. Specifies a file to override project settings. For example: [code]user://custom_settings.cfg[/code].