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

Improve the `File.store_{8,16,32,64}()` documentation 

Added information about the intervals of values that the functions
`store_{8,16,32,64}()` can correctly write to the file.
This commit is contained in:
Danil Alexeev 2020-03-25 18:02:04 +03:00
parent 35e700e931
commit 97e20b2f30
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/File.xml
View File

@ -297,6 +297,7 @@
</argument> </argument>
<description> <description>
Stores an integer as 16 bits in the file. 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> </description>
</method> </method>
<method name="store_32"> <method name="store_32">
@ -306,6 +307,7 @@
</argument> </argument>
<description> <description>
Stores an integer as 32 bits in the file. 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> </description>
</method> </method>
<method name="store_64"> <method name="store_64">
@ -315,6 +317,7 @@
</argument> </argument>
<description> <description>
Stores an integer as 64 bits in the file. 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> </description>
</method> </method>
<method name="store_8"> <method name="store_8">
@ -324,6 +327,7 @@
</argument> </argument>
<description> <description>
Stores an integer as 8 bits in the file. 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> </description>
</method> </method>
<method name="store_buffer"> <method name="store_buffer">