diff options
| author | kobewi <kobewi4e@gmail.com> | 2022-06-11 23:05:07 +0200 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2022-06-13 12:57:56 +0200 |
| commit | 1c90b066dd32d0a3fa0f1747be2836b70e7a0598 (patch) | |
| tree | 4d4b2a2b2da706f012b5078d8b7421801f17119c | |
| parent | 8df8fff54ba2263d53448b0a7f4e33fa76fdea50 (diff) | |
Improve description of move_to_trash()
| -rw-r--r-- | doc/classes/OS.xml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index 2512dec4b3..e6d5ea61da 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -469,7 +469,12 @@ <argument index="0" name="path" type="String" /> <description> Moves the file or directory to the system's recycle bin. See also [method Directory.remove]. + The method takes only global paths, so you may need to use [method ProjectSettings.globalize_path]. Do not use it for files in [code]res://[/code] as it will not work in exported project. [b]Note:[/b] If the user has disabled the recycle bin on their system, the file will be permanently deleted instead. + [codeblock] + var file_to_remove = "user://slot1.sav" + OS.move_to_trash(ProjectSettings.globalize_path(file_to_remove)) + [/codeblock] </description> </method> <method name="open_midi_inputs"> |