Improve description of move_to_trash()

(cherry picked from commit 1c90b066dd32d0a3fa0f1747be2836b70e7a0598)
This commit is contained in:
kobewi 2022-06-11 23:05:07 +02:00 committed by Relintai
parent d08f335224
commit 60c7ef815d

View File

@ -791,7 +791,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="move_window_to_foreground">