diff options
Diffstat (limited to 'doc/classes/File.xml')
| -rw-r--r-- | doc/classes/File.xml | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml index 9eff0a4d27..17c65731ff 100644 --- a/doc/classes/File.xml +++ b/doc/classes/File.xml @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8" ?> -<class name="File" inherits="Reference" category="Core" version="3.2"> +<class name="File" inherits="Reference" version="4.0"> <brief_description> Type to handle file reading and writing operations. </brief_description> @@ -87,16 +87,16 @@ </description> </method> <method name="get_buffer" qualifiers="const"> - <return type="PoolByteArray"> + <return type="PackedByteArray"> </return> <argument index="0" name="len" type="int"> </argument> <description> - Returns next [code]len[/code] bytes of the file as a [PoolByteArray]. + Returns next [code]len[/code] bytes of the file as a [PackedByteArray]. </description> </method> <method name="get_csv_line" qualifiers="const"> - <return type="PoolStringArray"> + <return type="PackedStringArray"> </return> <argument index="0" name="delim" type="String" default="",""> </argument> @@ -252,7 +252,7 @@ </argument> <argument index="1" name="mode_flags" type="int" enum="File.ModeFlags"> </argument> - <argument index="2" name="key" type="PoolByteArray"> + <argument index="2" name="key" type="PackedByteArray"> </argument> <description> Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -297,6 +297,7 @@ </argument> <description> Stores an integer as 16 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. </description> </method> <method name="store_32"> @@ -306,6 +307,7 @@ </argument> <description> Stores an integer as 32 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. </description> </method> <method name="store_64"> @@ -315,6 +317,7 @@ </argument> <description> Stores an integer as 64 bits in the file. + [b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value). </description> </method> <method name="store_8"> @@ -324,12 +327,13 @@ </argument> <description> Stores an integer as 8 bits in the file. + [b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. </description> </method> <method name="store_buffer"> <return type="void"> </return> - <argument index="0" name="buffer" type="PoolByteArray"> + <argument index="0" name="buffer" type="PackedByteArray"> </argument> <description> Stores the given array of bytes in the file. @@ -338,12 +342,12 @@ <method name="store_csv_line"> <return type="void"> </return> - <argument index="0" name="values" type="PoolStringArray"> + <argument index="0" name="values" type="PackedStringArray"> </argument> <argument index="1" name="delim" type="String" default="",""> </argument> <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 [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. + Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long. Text will be encoded as UTF-8. </description> </method> |