diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2018-02-23 21:58:14 +0700 |
|---|---|---|
| committer | Poommetee Ketson <poommetee@protonmail.com> | 2018-02-24 17:15:06 +0700 |
| commit | 2c22c9dcfbad9639fb9254eb822f9f930cf852db (patch) | |
| tree | 484996f436b300d402f12f9c97f17caf7c27117b /doc/classes | |
| parent | 92ece2e72744b1b82712bc20f37ac70d8e02ef00 (diff) | |
[DOCS] clarify that OS.get_user_data_dir needs project name
[ci skip]
Diffstat (limited to 'doc/classes')
| -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 f37c80efc9..0b11070ec2 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -385,6 +385,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"> |