godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify that eof_reached() cannot be used to check if more data is available

Browse Source
This commit is contained in:
Marcel Admiraal 2021-05-24 19:42:37 +01:00
parent 855406c882
commit b84714055b
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/File.xml
View File

@ -40,8 +40,12 @@
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the file cursor has read past the end of the file.
[b]Note:[/b] This function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic.
Returns [code]true[/code] if the file cursor has already read past the end of the file.
[b]Note:[/b] [code]eof_reached() == false[/code] cannot be used to check whether there is more data available. To loop while there is more data available, use:
[codeblock]
while file.get_position() &lt; file.get_len():
# Read data
[/codeblock]
</description>
</method>
<method name="file_exists" qualifiers="const">