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]
Close the currently opened file.
Returns [code]true[/code] if the file cursor reached the end of the file.
Returns [code]true[/code] if the file in the specified path exists.
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 8 bits from the file as an integer.
Get the whole file as a [String].
Get next len bytes of the file as a [PoolByteArray].
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).
Get the next 64 bits from the file as a floating point number.
Returns [code]true[/code] if endian swap is enabled for this 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 32 bits from the file as a floating point number.
Returns the size of the file in bytes.
Get the next line of the file as a [String].
Returns a MD5 String representing the file at the given path or an empty [String] on failure.
Returns the modified time in unix timestamp of the [code]file[/code] or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time].
Get a [String] saved in Pascal format from the file.
Returns the file cursor position.
Get the next bits from the file as a floating point number.
Returns a SHA-256 String representing the file at the given path or an empty [String] on failure.
Get the next Variant value from the file.
Returns [code]true[/code] if the file is currently opened.
Open the file for writing or reading, depending on the flags.
Open a compressed file for reading or writing. The compression_mode can be set as one of the COMPRESSION_* constants.
Open an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
Open an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
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.
If [code]true[/code] the file's endianness is swapped. Use 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.
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 an integer as 8 bits in the file.
Store the given array of bytes in the file.
Store a floating point number as 64 bits in the file.
Store a floating point number as 32 bits in the file.
Store the given [String] as a line 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).
Store a floating point number in the file.
Store the given [String] in the file.
Store any Variant value in the file.
Open the file for read operations.
Open the file for write operations. Create it if the file does not exist and truncate if it exists.
Open the file for read and write operations. Does not truncate the file.
Open the file for read and write operations. Create it if the file does not exist and truncate if it exists.
Use the FastLZ compression method.
Use the Deflate compression method.
Use the Zstd compression method.
Use the GZip compression method.