diff options
| author | kobewi <kobewi4e@gmail.com> | 2021-11-10 14:42:48 +0100 |
|---|---|---|
| committer | kobewi <kobewi4e@gmail.com> | 2021-12-02 18:37:25 +0100 |
| commit | 09b1fc1956f797bdb980caf556b3bc5e6a33ce56 (patch) | |
| tree | e01e22f9fdb2822f0aaac49144bf80625ce8a9fb /doc/classes/File.xml | |
| parent | e317e34c15cc0b2021198d6b53e515b29170c9f6 (diff) | |
Improve store_string() description
Diffstat (limited to 'doc/classes/File.xml')
| -rw-r--r-- | doc/classes/File.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 811aeb8aab..a2a47b4ffb 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -417,6 +417,7 @@ <argument index="0" name="string" type="String" /> <description> Appends [code]string[/code] to the file without a line return, 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> <method name="store_var"> |