diff options
| author | Poommetee Ketson | 2018-02-23 21:58:14 +0700 |
|---|---|---|
| committer | Rémi Verschelde | 2018-02-24 18:33:43 +0100 |
| commit | fe38b648b0a5b2d9e9ad2b1faf857f97ac9bbba6 (patch) | |
| tree | 5ff017632d5134e5491ed48230a5c6b2da17e6ef /doc/classes/OS.xml | |
| parent | ad325be5a08ca1a55b2d860df01153b604cb4058 (diff) | |
| download | godot-fe38b648b0a5b2d9e9ad2b1faf857f97ac9bbba6.tar.gz godot-fe38b648b0a5b2d9e9ad2b1faf857f97ac9bbba6.tar.zst godot-fe38b648b0a5b2d9e9ad2b1faf857f97ac9bbba6.zip | |
[DOCS] clarify that OS.get_user_data_dir needs project name
[ci skip]
(cherry picked from commit 2c22c9dcfbad9639fb9254eb822f9f930cf852db)
Diffstat (limited to '')
| -rw-r--r-- | doc/classes/OS.xml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e6cc69061..00903608e 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -384,6 +384,10 @@ </return> <description> Returns the absolute directory path where user data is written ([code]user://[/code]). + On Linux, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + On macOS, this is [code]~/Library/Application Support/Godot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + On Windows, this is [code]%APPDATA%/Godot/app_userdata/[project_name][/code], or [code]%APPDATA%/[custom_name][/code] if [code]use_custom_user_dir[/code] is set. + If the project name is empty, [code]user://[/code] falls back to [code]res://[/code]. </description> </method> <method name="get_virtual_keyboard_height"> |