diff options
| author | Gastronok | 2016-09-07 16:32:59 -0700 |
|---|---|---|
| committer | Rémi Verschelde | 2016-09-18 23:12:55 +0200 |
| commit | 3b691907e9e850ae80b415574bdcdc2a3511483c (patch) | |
| tree | a5f8abc55358f39a3b6d7c4676441e118fa4a2f4 /doc/base/classes.xml | |
| parent | 85eca7bc933988fe7210b134522db9342c9f0c7b (diff) | |
| download | godot-3b691907e9e850ae80b415574bdcdc2a3511483c.tar.gz godot-3b691907e9e850ae80b415574bdcdc2a3511483c.tar.zst godot-3b691907e9e850ae80b415574bdcdc2a3511483c.zip | |
Change the documentation to reflect that Directory.list_dir_begin()
returns true (not false) when a stream could not be initialized. (See, for
example,
https://github.com/godotengine/godot/blob/master/drivers/windows/dir_access_windows.cpp#L76
)
(cherry picked from commit cd82fafd5810248e261ac633f9c942125d90906a)
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 4bd10f752..91b2f03e8 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -10845,7 +10845,7 @@ </return> <description> Initialise 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]. - Return false if the stream could not be initialised. + Return true if the stream could not be initialised. </description> </method> <method name="list_dir_end"> |