summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-05-31 14:33:58 +0200
committerGitHub <noreply@github.com>2021-05-31 14:33:58 +0200
commit643da45e165a908fc49b201bd65bf326647306db (patch)
treeac47e58088ee7553060d8491a137fd8f9a086cea /doc
parent144759303de27ea2d5f73edd6965cc6b0d5b0fe3 (diff)
parentbd50006aae6e9a84489b40f4f56c50ef79953137 (diff)
Merge pull request #49173 from KoBeWi/navigational_oblivion
Tweak arguments of list_dir_begin() (skips navigational and hidden files by default)
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/Directory.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/Directory.xml b/doc/classes/Directory.xml
index a9d7960501..2c61d723cd 100644
--- a/doc/classes/Directory.xml
+++ b/doc/classes/Directory.xml
@@ -154,14 +154,14 @@
<method name="list_dir_begin">
<return type="int" enum="Error">
</return>
- <argument index="0" name="skip_navigational" type="bool" default="false">
+ <argument index="0" name="show_navigational" type="bool" default="false">
</argument>
- <argument index="1" name="skip_hidden" type="bool" default="false">
+ <argument index="1" name="show_hidden" type="bool" default="false">
</argument>
<description>
Initializes the stream used to list all files and directories using the [method get_next] function, closing the current opened stream if needed. Once the stream has been processed, it should typically be closed with [method list_dir_end].
- If [code]skip_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are filtered out.
- If [code]skip_hidden[/code] is [code]true[/code], hidden files are filtered out.
+ If [code]show_navigational[/code] is [code]true[/code], [code].[/code] and [code]..[/code] are included too.
+ If [code]show_hidden[/code] is [code]true[/code], hidden files are included too.
</description>
</method>
<method name="list_dir_end">