Merge pull request #49041 from madmiraal/fix-docs-4085
Clarify that eof_reached() cannot be used to check if more data is available
This commit is contained in:
commit
e156b0cc19
1 changed files with 14 additions and 2 deletions
|
@ -58,8 +58,20 @@
|
|||
<method name="eof_reached" qualifiers="const">
|
||||
<return type="bool" />
|
||||
<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_length] 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:
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
while file.get_position() < file.get_length():
|
||||
# Read data
|
||||
[/gdscript]
|
||||
[csharp]
|
||||
while (file.GetPosition() < file.GetLength())
|
||||
{
|
||||
// Read data
|
||||
}
|
||||
[/csharp]
|
||||
[/codeblocks]
|
||||
</description>
|
||||
</method>
|
||||
<method name="file_exists" qualifiers="const">
|
||||
|
|
Loading…
Reference in a new issue