File

Inherits: Reference < Object

Category: Core

Brief Description

Type to handle file reading and writing operations.

Member Functions

void close ( )
bool eof_reached ( ) const
bool file_exists ( String path ) const
int get_16 ( ) const
int get_32 ( ) const
int get_64 ( ) const
int get_8 ( ) const
String get_as_text ( ) const
PoolByteArray get_buffer ( int len ) const
PoolStringArray get_csv_line ( String delim=”,” ) const
float get_double ( ) const
bool get_endian_swap ( )
int get_error ( ) const
float get_float ( ) const
int get_len ( ) const
String get_line ( ) const
String get_md5 ( String path ) const
int get_modified_time ( String file ) const
String get_pascal_string ( )
int get_position ( ) const
float get_real ( ) const
String get_sha256 ( String path ) const
Variant get_var ( ) const
bool is_open ( ) const
int open ( String path, int flags )
int open_compressed ( String path, int mode_flags, int compression_mode=0 )
int open_encrypted ( String path, int mode_flags, PoolByteArray key )
int open_encrypted_with_pass ( String path, int mode_flags, String pass )
void seek ( int position )
void seek_end ( int position=0 )
void set_endian_swap ( bool enable )
void store_16 ( int value )
void store_32 ( int value )
void store_64 ( int value )
void store_8 ( int value )
void store_buffer ( PoolByteArray buffer )
void store_double ( float value )
void store_float ( float value )
void store_line ( String line )
void store_pascal_string ( String string )
void store_real ( float value )
void store_string ( String string )
void store_var ( Variant value )

Numeric Constants

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

Member Function Description

  • void close ( )

Closes the currently opened file.

  • bool eof_reached ( ) const

Returns true if the file cursor has reached the end of the file.

Returns true if the file exists in the given path.

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

Returns next len bytes of the file as a PoolByteArray.

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

  • float get_double ( ) const

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

  • bool get_endian_swap ( )

Returns true if endian swap is enabled for this file.

  • int get_error ( ) const

Returns the last error that happened when trying to perform operations. Compare with the ERR_FILE\_\* constants from @GlobalScope.

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

Returns the next line of the file as a String.

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.

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

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.

  • bool is_open ( ) const

Returns true if the file is currently opened.

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

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

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

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.

  • 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 set_endian_swap ( bool enable )

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 reseted to false whenever you open 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.

Stores the given array of bytes in the file.

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

  • 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).

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

Stores any Variant value in the file.