Type to handle file reading and writing operations.
    public class File : Reference

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]

Inheritance Chain

Constructors

    public File()

Properties

    public bool EndianSwap { get; set; }

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.

Methods

    public void Close()

Closes the currently opened file.

    public bool EofReached()

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

    public bool FileExists(string path)

Returns true if the file exists in the given path.

    public int Get16()

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

    public int Get32()

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

    public int Get64()

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

    public int Get8()

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

    public string GetAsText()

Returns the whole file as a String.

    public byte[] GetBuffer(int len)

Returns next len bytes of the file as a PoolByteArray.

    public string[] GetCsvLine(string delim = ",")

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

    public float GetDouble()

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

    public bool GetEndianSwap()

Getter for EndianSwap

    public Error GetError()

Returns the last error that happened when trying to perform operations. Compare with the ERR_FILE_* constants from [@GlobalScope].

    public float GetFloat()

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

    public int GetLen()

Returns the size of the file in bytes.

    public string GetLine()

Returns the next line of the file as a String.

    public string GetMd5(string path)

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

    public int GetModifiedTime(string file)

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.GetDatetimeFromUnixTime(int).

    public string GetPascalString()

Returns a String saved in Pascal format from the file.

    public int GetPosition()

Returns the file cursor’s position.

    public float GetReal()

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

    public string GetSha256(string path)

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

    public object GetVar()

Returns the next Variant value from the file.

    public bool IsOpen()

Returns true if the file is currently opened.

    public Error Open(string path, int flags)

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

    public Error OpenCompressed(string path, int modeFlags, int compressionMode = 0)

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

    public Error OpenEncrypted(string path, int modeFlags, byte[] key)

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

    public Error OpenEncryptedWithPass(string path, int modeFlags, string pass)

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

    public void Seek(int position)

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

    public void SeekEnd(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.

    public void SetEndianSwap(bool enable)

Setter for EndianSwap

    public void Store16(int value)

Stores an integer as 16 bits in the file.

    public void Store32(int value)

Stores an integer as 32 bits in the file.

    public void Store64(int value)

Stores an integer as 64 bits in the file.

    public void Store8(int value)

Stores an integer as 8 bits in the file.

    public void StoreBuffer(byte[] buffer)

Stores the given array of bytes in the file.

    public void StoreDouble(float value)

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

    public void StoreFloat(float value)

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

    public void StoreLine(string line)

Stores the given String as a line in the file.

    public void StorePascalString(string @string)

Stores the given String as a line in the file in Pascal format (i.e. also store the length of the string).

    public void StoreReal(float value)

Stores a floating point number in the file.

    public void StoreString(string @string)

Stores the given String in the file.

    public void StoreVar(object value)

Stores any Variant value in the file.

Inner Types

CompressionMode

Name Value Description
Fastlz 0 Uses the FastLZ compression method.
Deflate 1 Uses the Deflate compression method.
Zstd 2 Uses the Zstd compression method.
Gzip 3 Uses the gzip compression method.

ModeFlags

Name Value Description
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.
ReadWrite 3 Opens the file for read and write operations. Does not truncate the file.
WriteRead 7 Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.
Tags: