File

Inherits: Reference < Object

Category: Core

Brief Description

Type to handle file reading and writing operations.

Properties

Methods

Enumerations

enum ModeFlags:

• READ = 1 — Opens the file for read operations.
• WRITE = 2 — Opens the file for write operations. Create it if the file does not exist and truncate if it exists.
• READ_WRITE = 3 — Opens the file for read and write operations. Does not truncate the file.
• WRITE_READ = 7 — Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.

enum CompressionMode:

• COMPRESSION_FASTLZ = 0 — Uses the FastLZ compression method.
• COMPRESSION_DEFLATE = 1 — Uses the Deflate compression method.
• COMPRESSION_ZSTD = 2 — Uses the Zstd compression method.
• COMPRESSION_GZIP = 3 — Uses the gzip compression method.

Description

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:

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

Tutorials

• File system

Property Descriptions

• bool endian_swap

If true, 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 reset to false whenever you open the file.

Method Descriptions

• void close ( )

Closes the currently opened file.

• bool eof_reached ( ) const

Returns true if the file cursor has read past the end of the file. Note that this function will still return false 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 get_len and get_position to implement a custom logic.

• bool file_exists ( String path ) const

Returns true if the file exists in the given path.

Note that 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 res://.import folder). To check for the existence of such resources while taking into account the remapping to their imported location, use ResourceLoader.exists. Typically, using File.file_exists on an imported resource would work while you are developing in the editor (the source asset is present in res://, but fail when exported).

• int get_16 ( ) const

Returns the next 16 bits from the file as an integer.

• int get_32 ( ) const

Returns the next 32 bits from the file as an integer.

• int get_64 ( ) const

Returns the next 64 bits from the file as an integer.

• int get_8 ( ) const

Returns the next 8 bits from the file as an integer.

• String get_as_text ( ) const

Returns the whole file as a String.

Text is interpreted as being UTF-8 encoded.

• PoolByteArray get_buffer ( int len ) const

Returns next len bytes of the file as a PoolByteArray.

• PoolStringArray get_csv_line ( String delim=”,” ) const

Returns 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), it should be one character long.

Text is interpreted as being UTF-8 encoded.

• float get_double ( ) const

Returns the next 64 bits from the file as a floating point number.

• Error get_error ( ) const

Returns the last error that happened when trying to perform operations. Compare with the ERR_FILE_* constants from Error.

• float get_float ( ) const

Returns the next 32 bits from the file as a floating point number.

• int get_len ( ) const

Returns the size of the file in bytes.

• String get_line ( ) const

Returns the next line of the file as a String.

Text is interpreted as being UTF-8 encoded.

• String get_md5 ( String path ) const

Returns an MD5 String representing the file at the given path or an empty String on failure.

• int get_modified_time ( String file ) const

Returns the last time the file was modified in unix timestamp format or returns a String “ERROR IN file”. This unix timestamp can be converted to datetime by using OS.get_datetime_from_unix_time.

• String get_pascal_string ( )

Returns a String saved in Pascal format from the file.

Text is interpreted as being UTF-8 encoded.

• String get_path ( ) const

Returns the path as a String for the current open file.

• String get_path_absolute ( ) const

Returns the absolute path as a String for the current open file.

• int get_position ( ) const

Returns the file cursor’s position.

• float get_real ( ) const

Returns the next bits from the file as a floating point number.

• String get_sha256 ( String path ) const

Returns a SHA-256 String representing the file at the given path or an empty String on failure.

• Variant get_var ( bool allow_objects=false ) const

Returns the next Variant value from the file. When allow_objects is true decoding objects is allowed.

WARNING: Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution).

• bool is_open ( ) const

Returns true if the file is currently opened.

• Error open ( String path, int flags )

Opens the file for writing or reading, depending on the flags.

• Error open_compressed ( String path, int mode_flags, int compression_mode=0 )

Opens a compressed file for reading or writing. Use CompressionMode constants to set compression_mode.

• Error open_encrypted ( String path, int mode_flags, PoolByteArray key )

Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.

• Error open_encrypted_with_pass ( String path, int mode_flags, String pass )

Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.

• void seek ( int position )

Change the file reading/writing cursor to the specified position (in bytes from the beginning of the file).

• void seek_end ( int position=0 )

Changes 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.

• void store_16 ( int value )

Stores an integer as 16 bits in the file.

• void store_32 ( int value )

Stores an integer as 32 bits in the file.

• void store_64 ( int value )

Stores an integer as 64 bits in the file.

• void store_8 ( int value )

Stores an integer as 8 bits in the file.

• void store_buffer ( PoolByteArray buffer )

Stores the given array of bytes in the file.

• void store_csv_line ( PoolStringArray values, String delim=”,” )

Store the given PoolStringArray in the file as a line formatted in the CSV (Comma Separated Values) format. You can pass a different delimiter to use other than the default “,” (comma), it should be one character long.

Text will be encoded as UTF-8.

• void store_double ( float value )

Stores a floating point number as 64 bits in the file.

• void store_float ( float value )

Stores a floating point number as 32 bits in the file.

• void store_line ( String line )

Stores the given String as a line in the file.

Text will be encoded as UTF-8.

• void store_pascal_string ( String string )

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.

• void store_real ( float value )

Stores a floating point number in the file.

• void store_string ( String string )

Stores the given String in the file.

Text will be encoded as UTF-8.

• void store_var ( Variant value, bool full_objects=false )

Stores any Variant value in the file. When full_objects is true encoding objects is allowed (and can potentially include code).