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

Clarify encoding used for text by the File class 

(cherry picked from commit d1c095b30a)
This commit is contained in:
shartte 2019-03-06 18:26:32 +01:00 committed by Rémi Verschelde
parent e8e57c49de
commit a4610ca61e
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/File.xml
View File

@ -84,6 +84,7 @@
</return> </return>
<description> <description>
Returns the whole file as a [String]. Returns the whole file as a [String].
Text is interpreted as being UTF-8 encoded.
</description> </description>
</method> </method>
<method name="get_buffer" qualifiers="const"> <method name="get_buffer" qualifiers="const">
@ -102,6 +103,7 @@
</argument> </argument>
<description> <description>
Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. Returns the next value of the file in CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
Text is interpreted as being UTF-8 encoded.
</description> </description>
</method> </method>
<method name="get_double" qualifiers="const"> <method name="get_double" qualifiers="const">
@ -137,6 +139,7 @@
</return> </return>
<description> <description>
Returns the next line of the file as a [String]. Returns the next line of the file as a [String].
Text is interpreted as being UTF-8 encoded.
</description> </description>
</method> </method>
<method name="get_md5" qualifiers="const"> <method name="get_md5" qualifiers="const">
@ -162,6 +165,7 @@
</return> </return>
<description> <description>
Returns a [String] saved in Pascal format from the file. Returns a [String] saved in Pascal format from the file.
Text is interpreted as being UTF-8 encoded.
</description> </description>
</method> </method>
<method name="get_path" qualifiers="const"> <method name="get_path" qualifiers="const">
@ -337,6 +341,7 @@
</argument> </argument>
<description> <description>
Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long. Store the given [PoolStringArray] in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default "," (comma), it should be one character long.
Text will be encoded as UTF-8.
</description> </description>
</method> </method>
<method name="store_double"> <method name="store_double">
@ -364,6 +369,7 @@
</argument> </argument>
<description> <description>
Stores the given [String] as a line in the file. Stores the given [String] as a line in the file.
Text will be encoded as UTF-8.
</description> </description>
</method> </method>
<method name="store_pascal_string"> <method name="store_pascal_string">
@ -373,6 +379,7 @@
</argument> </argument>
<description> <description>
Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). Stores the given [String] as a line in the file in Pascal format (i.e. also store the length of the string).
Text will be encoded as UTF-8.
</description> </description>
</method> </method>
<method name="store_real"> <method name="store_real">
@ -391,6 +398,7 @@
</argument> </argument>
<description> <description>
Stores the given [String] in the file. Stores the given [String] in the file.
Text will be encoded as UTF-8.
</description> </description>
</method> </method>
<method name="store_var"> <method name="store_var">