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]
https://docs.godotengine.org/en/latest/getting_started/step_by_step/filesystem.html
Closes the currently opened file.
Returns [code]true[/code] if the file cursor has read past the end of the file. [b]Note:[/b] This function will still return [code]false[/code] while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always [method get_len] and [method get_position] to implement a custom logic.
Returns [code]true[/code] if the file exists in the given path. [b]Note:[/b] Many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the [code]res://.import[/code] folder). To check for the existence of such resources while taking into account the remapping to their imported location, use [method ResourceLoader.exists]. Typically, using [code]File.file_exists[/code] on an imported resource would work while you are developing in the editor (the source asset is present in [code]res://[/code], but fail when exported).
Returns the next 16 bits from the file as an integer.
Returns the next 32 bits from the file as an integer.
Returns the next 64 bits from the file as an integer.
Returns the next 8 bits from the file as an integer.
Returns the whole file as a [String]. Text is interpreted as being UTF-8 encoded.
Returns next [code]len[/code] bytes of the file as a [PackedByteArray].
Returns the next value of the file in 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 is interpreted as being UTF-8 encoded.
Returns the next 64 bits from the file as a floating-point number.
Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [enum Error].
Returns the next 32 bits from the file as a floating-point number.
Returns the size of the file in bytes.
Returns the next line of the file as a [String]. Text is interpreted as being UTF-8 encoded.
Returns an MD5 String representing the file at the given path or an empty [String] on failure.
Returns the last time the [code]file[/code] was modified in unix timestamp format 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].
Returns a [String] saved in Pascal format from the file. Text is interpreted as being UTF-8 encoded.
Returns the path as a [String] for the current open file.
Returns the absolute path as a [String] for the current open file.
Returns the file cursor's position.
Returns 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.
Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
Returns [code]true[/code] if the file is currently opened.
Opens the file for writing or reading, depending on the flags.
Opens a compressed file for reading or writing.
Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
Changes the file reading/writing cursor to the specified position (in bytes from the end of the file). [b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of 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].
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].
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).
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].
Stores the given array of bytes in the file.
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.
Stores a floating-point number as 64 bits in the file.
Stores a floating-point number as 32 bits in the file.
Stores the given [String] as a line in the file. Text will be encoded as UTF-8.
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.
Stores a floating-point number in the file.
Stores the given [String] in the file. Text will be encoded as UTF-8.
Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code).
- If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. [b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file.
Opens the file for read operations.
Opens the file for write operations. Create it if the file does not exist and truncate if it exists.
Opens the file for read and write operations. Does not truncate the file.
Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.
Uses the [url=http://fastlz.org/]FastLZ[/url] compression method.
Uses the [url=https://en.wikipedia.org/wiki/DEFLATE]DEFLATE[/url] compression method.
Uses the [url=https://facebook.github.io/zstd/]Zstandard[/url] compression method.
Uses the [url=https://www.gzip.org/]gzip[/url] compression method.