diff options
| author | Thaddeus Crews <repiteo@outlook.com> | 2024-10-16 14:16:05 -0500 |
|---|---|---|
| committer | Thaddeus Crews <repiteo@outlook.com> | 2024-10-16 14:16:05 -0500 |
| commit | 04692d83cb8f61002f18ea1d954df8c558ee84f7 (patch) | |
| tree | 5812e710da2067681413f6ceae754994f7e55052 | |
| parent | 324659f0ca646a8ca1da32bcbdb485ba33a34189 (diff) | |
| parent | e7e0e6515975ddb6c37d3cb80e7ab2c17d72c7e9 (diff) | |
| download | redot-engine-04692d83cb8f61002f18ea1d954df8c558ee84f7.tar.gz | |
Merge pull request #98238 from timothyqiu/not-append
Fix wording in description of `store_line` and `store_string`
| -rw-r--r-- | doc/classes/FileAccess.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/FileAccess.xml b/doc/classes/FileAccess.xml index 71a1fc8e09..5888e30339 100644 --- a/doc/classes/FileAccess.xml +++ b/doc/classes/FileAccess.xml @@ -474,7 +474,7 @@ <return type="void" /> <param index="0" name="line" type="String" /> <description> - Appends [param line] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8. + Stores [param line] in the file followed by a newline character ([code]\n[/code]), encoding the text as UTF-8. </description> </method> <method name="store_pascal_string"> @@ -496,7 +496,7 @@ <return type="void" /> <param index="0" name="string" type="String" /> <description> - Appends [param string] to the file without a line return, encoding the text as UTF-8. + Stores [param string] in the file without a newline character ([code]\n[/code]), encoding the text as UTF-8. [b]Note:[/b] This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using [method store_pascal_string] instead. For retrieving strings from a text file, you can use [code]get_buffer(length).get_string_from_utf8()[/code] (if you know the length) or [method get_as_text]. </description> </method> |