diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2022-04-27 07:55:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-27 07:55:33 +0200 |
| commit | 8121db871ad038444bd77ef2918cfc5b731e45f3 (patch) | |
| tree | 0b50593cd1074ae958514abd6feb43d5307503ba /doc/classes | |
| parent | 14caf9ee73e10ac857021538be356dbc84993411 (diff) | |
| parent | b80e52f04899d28ea191ce3eaad9fdb76bc11b52 (diff) | |
Merge pull request #60542 from KoBeWi/garbage
Expose `move_to_trash()`
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/Directory.xml | 3 | ||||
| -rw-r--r-- | doc/classes/OS.xml | 8 |
2 files changed, 10 insertions, 1 deletions
diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml index 7d72cd867c..bd16fd3936 100644 --- a/doc/classes/Directory.xml +++ b/doc/classes/Directory.xml @@ -196,7 +196,8 @@ <return type="int" enum="Error" /> <argument index="0" name="path" type="String" /> <description> - Deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. + Permanently deletes the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail. + If you don't want to delete the file/directory permanently, use [method OS.move_to_trash] instead. Returns one of the [enum Error] code constants ([code]OK[/code] on success). </description> </method> diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index b2e325d226..f45bee4db4 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -455,6 +455,14 @@ [b]Note:[/b] This method is implemented on Android, iOS, Linux, macOS and Windows. </description> </method> + <method name="move_to_trash" qualifiers="const"> + <return type="int" enum="Error" /> + <argument index="0" name="path" type="String" /> + <description> + Moves the file or directory to the system's recycle bin. See also [method Directory.remove]. + [b]Note:[/b] If the user has disabled the recycle bin on their system, the file will be permanently deleted instead. + </description> + </method> <method name="open_midi_inputs"> <return type="void" /> <description> |