From aa581a067dde0f64d8f3a594bfcae01e563ca74b Mon Sep 17 00:00:00 2001 From: George Marques Date: Mon, 20 Jun 2016 18:38:13 -0300 Subject: [PATCH] Add classref for File class (cherry picked from commit 4d33eb01d7d29e32359df7a072f96a084fc7bd05) --- doc/base/classes.xml | 64 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 910b87a99b0..530580e06dc 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -11028,8 +11028,27 @@ This approximation makes straight segments between each point, then subdivides t + Type to handle file reading and writing operations. + File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. + + Here's a sample on how to write and read from a file: + + [codeblock] + func save(content): + var file = File.new() + file.open("user://save_game.dat", file.WRITE) + file.store_string(content) + file.close() + + func load(): + var file = File.new() + file.open("user://save_game.dat", file.READ) + var content = file.get_as_text() + file.close() + return content + [/codeblock] @@ -11042,6 +11061,7 @@ This approximation makes straight segments between each point, then subdivides t + Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it. @@ -11054,6 +11074,7 @@ This approximation makes straight segments between each point, then subdivides t + Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it. @@ -11064,88 +11085,103 @@ This approximation makes straight segments between each point, then subdivides t + Open the file for writing or reading, depending on the flags. + Close the currently opened file. + Return whether the file is currently opened. + Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file). + Change the file reading/writing cursor to the specified position (in bytes from the end of the file). Note that this is an offset, so you should use negative numbers or the cursor will be at the end of the file. + Return the file cursor position. + Return the size of the file in bytes. + Return whether the file cursor reached the end of the file. + Get the next 8 bits from the file as an integer. + Get the next 16 bits from the file as an integer. + Get the next 32 bits from the file as an integer. + Get the next 64 bits from the file as an integer. + Get the next 32 bits from the file as a floating point number. + Get the next 64 bits from the file as a floating point number. + Get the next bits from the file as a floating point number. @@ -11154,40 +11190,49 @@ This approximation makes straight segments between each point, then subdivides t + Get next len bytes of the file as a [RawArray]. + Get the next line of the file as a [String]. + Get the whole file as a [String]. + Get whether endian swap is enabled for this file. + Set whether to swap the endianess of the file. Enable this if you're dealing with files written in big endian machines. + + Note that this is about the file format, not CPU type. This is always reseted to [code]false[/code] whenever you open the file. + Get the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope]. + Get the next Variant value from the file. @@ -11196,84 +11241,98 @@ This approximation makes straight segments between each point, then subdivides t + Get 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). + Store an integer as 8 bits in the file. + Store an integer as 16 bits in the file. + Store an integer as 32 bits in the file. + Store an integer as 64 bits in the file. + Store a floating point number as 32 bits in the file. + Store a floating point number as 64 bits in the file. + Store a floating point number in the file. + Store the given array of bytes in the file. + Store the given [String] as a line in the file. + Store the given [String] in the file. + Store any Variant value in the file. + Store the given [String] as a line in the file in Pascal format (i.e. also store the length of the string). + Get a [String] saved in Pascal format from the file. @@ -11282,17 +11341,22 @@ This approximation makes straight segments between each point, then subdivides t + Get whether or not the file in the specified path exists. + Open the file for reading. + Open the file for writing. Create it if the file not exists and truncate if it exists. + Open the file for reading and writing, without truncating the file. + Open the file for reading and writing. Create it if the file not exists and truncate if it exists.