Class FileAccess

Provides methods for file reading and writing operations.

Inheritance

RefCounted

Object

FileAccess

Remarks

This class can be used to permanently store data in the user device's file system and to read from it. This is useful for storing game save data or player configuration files.

Here's a sample on how to write and read from a file:

• gdscript
• C#

func save_to_file(content):
    var file = FileAccess.open("user://save_game.dat", FileAccess.WRITE)
    file.store_string(content)

func load_from_file():
    var file = FileAccess.open("user://save_game.dat", FileAccess.READ)
    var content = file.get_as_text()
    return content

In the example above, the file will be saved in the user data folder as specified in the Data paths documentation.

FileAccess will close when it's freed, which happens when it goes out of scope or when it gets assigned with null. close can be used to close it before then explicitly. In C# the reference must be disposed manually, which can be done with the using statement or by calling the Dispose method directly.

Note: To access project resources once exported, it is recommended to use ResourceLoader instead of FileAccess, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package. If using FileAccess, make sure the file is included in the export by changing its import mode to Keep File (exported as is) in the Import dock, or, for files where this option is not available, change the non-resource export filter in the Export dialog to include the file's extension (e.g. *.txt).

Note: Files are automatically closed only if the process exits "normally" (such as by clicking the window manager's close button or pressing Alt + F4). If you stop the project execution by pressing F8 while the project is running, the file won't be closed as the game process will be killed. You can work around this by calling flush at regular intervals.

See Also

File system

Runtime file loading and saving

3D Voxel Demo

Properties

big_endian

If true, the file is read with big-endian endianness. If false, the file is read with little-endian endianness. If in doubt, leave this to false as most files are written with little-endian endianness.

Note: big_endian is only about the file format, not the CPU type. The CPU endianness doesn't affect the default endianness for files written.

Note: This is always reset to false whenever you open the file. Therefore, you must set big_endian after opening the file, not before.

var big_endian : bool

Property Value

bool

Remarks

• void set_big_endian(bool value)
• bool is_big_endian

Methods

close

Closes the currently opened file and prevents subsequent read/write operations. Use flush to persist the data to disk without closing the file.

Note: FileAccess will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with null. In C# the reference must be disposed after we are done using it, this can be done with the using statement or calling the Dispose method directly.

void close

create_temp(int, String, String, bool)

Qualifiers: static

Creates a temporary file. This file will be freed when the returned FileAccess is freed.

If prefix is not empty, it will be prefixed to the file name, separated by a -.

If extension is not empty, it will be appended to the temporary file name.

If keep is true, the file is not deleted when the returned FileAccess is freed.

Returns null if opening the file failed. You can use get_open_error to check the error that occurred.

FileAccess create_temp(int mode_flags, String prefix, String extension, bool keep)

Parameters

mode_flags int

prefix String

extension String

keep bool

eof_reached

Qualifiers: const

Returns true if the file cursor has already read past the end of the file.

Note: eof_reached() == false cannot be used to check whether there is more data available. To loop while there is more data available, use:

• gdscript
• C#

while file.get_position() < file.get_length():
    # Read data

bool eof_reached

file_exists(String)

Qualifiers: static

Returns true if the file exists in the given path.

Note: Many resources types are imported (e.g. textures or sound files), and their source asset will not be included in the exported game, as only the imported version is used. See ResourceLoader.exists for an alternative approach that takes resource remapping into account.

For a non-static, relative equivalent, use DirAccess.file_exists.

bool file_exists(String path)

Parameters

path String

flush

Writes the file's buffer to disk. Flushing is automatically performed when the file is closed. This means you don't need to call flush manually before closing a file. Still, calling flush can be used to ensure the data is safe even if the project crashes instead of being closed gracefully.

Note: Only call flush when you actually need it. Otherwise, it will decrease performance due to constant disk writes.

void flush

get_8

Qualifiers: const

Returns the next 8 bits from the file as an integer. See FileAccess.store_8 for details on what values can be stored and retrieved this way.

int get_8

get_16

Qualifiers: const

Returns the next 16 bits from the file as an integer. See FileAccess.store_16 for details on what values can be stored and retrieved this way.

int get_16

get_32

Qualifiers: const

Returns the next 32 bits from the file as an integer. See FileAccess.store_32 for details on what values can be stored and retrieved this way.

int get_32

get_64

Qualifiers: const

Returns the next 64 bits from the file as an integer. See FileAccess.store_64 for details on what values can be stored and retrieved this way.

int get_64

get_as_text(bool)

Qualifiers: const

Returns the whole file as a String. Text is interpreted as being UTF-8 encoded.

If skip_cr is true, carriage return characters (\r, CR) will be ignored when parsing the UTF-8, so that only line feed characters (\n, LF) represent a new line (Unix convention).

String get_as_text(bool skip_cr)

Parameters

skip_cr bool

get_buffer(int)

Qualifiers: const

Returns next length bytes of the file as a PackedByteArray.

PackedByteArray get_buffer(int length)

Parameters

length int

get_csv_line(String)

Qualifiers: const

Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long, and cannot be a double quotation mark.

Text is interpreted as being UTF-8 encoded. Text values must be enclosed in double quotes if they include the delimiter character. Double quotes within a text value can be escaped by doubling their occurrence.

For example, the following CSV lines are valid and will be properly parsed as two strings each:

• text

Alice,"Hello, Bob!"
Bob,Alice! What a surprise!
Alice,"I thought you'd reply with ""Hello, world""."

Note how the second line can omit the enclosing quotes as it does not include the delimiter. However it could very well use quotes, it was only written without for demonstration purposes. The third line must use "" for each quotation mark that needs to be interpreted as such instead of the end of a text value.

PackedStringArray get_csv_line(String delim)

Parameters

delim String

get_double

Qualifiers: const

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

float get_double

get_error

Qualifiers: const

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

int get_error

get_file_as_bytes(String)

Qualifiers: static

Returns the whole path file contents as a PackedByteArray without any decoding.

Returns an empty PackedByteArray if an error occurred while opening the file. You can use get_open_error to check the error that occurred.

PackedByteArray get_file_as_bytes(String path)

Parameters

path String

get_file_as_string(String)

Qualifiers: static

Returns the whole path file contents as a String. Text is interpreted as being UTF-8 encoded.

Returns an empty String if an error occurred while opening the file. You can use get_open_error to check the error that occurred.

String get_file_as_string(String path)

Parameters

path String

get_float

Qualifiers: const

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

float get_float

get_half

Qualifiers: const

Returns the next 16 bits from the file as a half-precision floating-point number.

float get_half

get_hidden_attribute(String)

Qualifiers: static

Returns true, if file hidden attribute is set.

Note: This method is implemented on iOS, BSD, macOS, and Windows.

bool get_hidden_attribute(String file)

Parameters

file String

get_length

Qualifiers: const

Returns the size of the file in bytes. For a pipe, returns the number of bytes available for reading from the pipe.

int get_length

get_line

Qualifiers: const

Returns the next line of the file as a String. The returned string doesn't include newline (\n) or carriage return (\r) characters, but does include any other leading or trailing whitespace.

Text is interpreted as being UTF-8 encoded.

String get_line

get_md5(String)

Qualifiers: static

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

String get_md5(String path)

Parameters

path String

get_modified_time(String)

Qualifiers: static

Returns the last time the file was modified in Unix timestamp format, or 0 on error. This Unix timestamp can be converted to another format using the Time singleton.

int get_modified_time(String file)

Parameters

file String

get_open_error

Qualifiers: static

Returns the result of the last FileAccess.open call in the current thread.

int get_open_error

get_pascal_string

Returns a String saved in Pascal format from the file.

Text is interpreted as being UTF-8 encoded.

String get_pascal_string

get_path

Qualifiers: const

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

String get_path

get_path_absolute

Qualifiers: const

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

String get_path_absolute

get_position

Qualifiers: const

Returns the file cursor's position.

int get_position

get_read_only_attribute(String)

Qualifiers: static

Returns true, if file read only attribute is set.

Note: This method is implemented on iOS, BSD, macOS, and Windows.

bool get_read_only_attribute(String file)

Parameters

file String

get_real

Qualifiers: const

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

float get_real

get_sha256(String)

Qualifiers: static

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

String get_sha256(String path)

Parameters

path String

get_unix_permissions(String)

Qualifiers: static

Returns file UNIX permissions.

Note: This method is implemented on iOS, Linux/BSD, and macOS.

int get_unix_permissions(String file)

Parameters

file String

get_var(bool)

Qualifiers: const

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

Internally, this uses the same decoding mechanism as the @GlobalScope.bytes_to_var method.

Warning: 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.

Variant get_var(bool allow_objects)

Parameters

allow_objects bool

is_open

Qualifiers: const

Returns true if the file is currently opened.

bool is_open

open(String, int)

Qualifiers: static

Creates a new FileAccess object and opens the file for writing or reading, depending on the flags.

Returns null if opening the file failed. You can use get_open_error to check the error that occurred.

FileAccess open(String path, int flags)

Parameters

path String

flags int

open_compressed(String, int, int)

Qualifiers: static

Creates a new FileAccess object and opens a compressed file for reading or writing.

Note: FileAccess.open_compressed can only read files that were saved by Godot, not third-party compression formats. See GitHub issue #28999 for a workaround.

Returns null if opening the file failed. You can use get_open_error to check the error that occurred.

FileAccess open_compressed(String path, int mode_flags, int compression_mode)

Parameters

path String

mode_flags int

compression_mode int

open_encrypted(String, int, PackedByteArray, PackedByteArray)

Qualifiers: static

Creates a new FileAccess object and opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.

Note: The provided key must be 32 bytes long.

Returns null if opening the file failed. You can use get_open_error to check the error that occurred.

FileAccess open_encrypted(String path, int mode_flags, PackedByteArray key, PackedByteArray iv)

Parameters

path String

mode_flags int

key PackedByteArray

iv PackedByteArray

open_encrypted_with_pass(String, int, String)

Qualifiers: static

Creates a new FileAccess object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.

Returns null if opening the file failed. You can use get_open_error to check the error that occurred.

FileAccess open_encrypted_with_pass(String path, int mode_flags, String pass)

Parameters

path String

mode_flags int

pass String

resize(int)

Resizes the file to a specified length. The file must be open in a mode that permits writing. If the file is extended, NUL characters are appended. If the file is truncated, all data from the end file to the original length of the file is lost.

int resize(int length)

Parameters

length int

seek(int)

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

void seek(int position)

Parameters

position int

seek_end(int)

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

Note: This is an offset, so you should use negative numbers or the cursor will be at the end of the file.

void seek_end(int position)

Parameters

position int

set_hidden_attribute(String, bool)

Qualifiers: static

Sets file hidden attribute.

Note: This method is implemented on iOS, BSD, macOS, and Windows.

int set_hidden_attribute(String file, bool hidden)

Parameters

file String

hidden bool

set_read_only_attribute(String, bool)

Qualifiers: static

Sets file read only attribute.

Note: This method is implemented on iOS, BSD, macOS, and Windows.

int set_read_only_attribute(String file, bool ro)

Parameters

file String

ro bool

set_unix_permissions(String, int)

Qualifiers: static

Sets file UNIX permissions.

Note: This method is implemented on iOS, Linux/BSD, and macOS.

int set_unix_permissions(String file, int permissions)

Parameters

file String

permissions int

store_8(int)

Stores an integer as 8 bits in the file.

Note: The value should lie in the interval [0, 255]. Any other value will overflow and wrap around.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

To store a signed integer, use FileAccess.store_64, or convert it manually (see FileAccess.store_16 for an example).

bool store_8(int value)

Parameters

value int

store_16(int)

Stores an integer as 16 bits in the file.

Note: The value should lie in the interval [0, 2^16 - 1]. Any other value will overflow and wrap around.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

To store a signed integer, use FileAccess.store_64 or store a signed integer from the interval [-2^15, 2^15 - 1] (i.e. keeping one bit for the signedness) and compute its sign manually when reading. For example:

• gdscript
• C#

const MAX_15B = 1 << 15
const MAX_16B = 1 << 16

func unsigned16_to_signed(unsigned):
    return (unsigned + MAX_15B) % MAX_16B - MAX_15B

func _ready():
    var f = FileAccess.open("user://file.dat", FileAccess.WRITE_READ)
    f.store_16(-42) # This wraps around and stores 65494 (2^16 - 42).
    f.store_16(121) # In bounds, will store 121.
    f.seek(0) # Go back to start to read the stored value.
    var read1 = f.get_16() # 65494
    var read2 = f.get_16() # 121
    var converted1 = unsigned16_to_signed(read1) # -42
    var converted2 = unsigned16_to_signed(read2) # 121

bool store_16(int value)

Parameters

value int

store_32(int)

Stores an integer as 32 bits in the file.

Note: The value should lie in the interval [0, 2^32 - 1]. Any other value will overflow and wrap around.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

To store a signed integer, use FileAccess.store_64, or convert it manually (see FileAccess.store_16 for an example).

bool store_32(int value)

Parameters

value int

store_64(int)

Stores an integer as 64 bits in the file.

Note: The value must lie in the interval [-2^63, 2^63 - 1] (i.e. be a valid int value).

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_64(int value)

Parameters

value int

store_buffer(PackedByteArray)

Stores the given array of bytes in the file.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_buffer(PackedByteArray buffer)

Parameters

buffer PackedByteArray

store_csv_line(PackedStringArray, String)

Store the given PackedStringArray in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter delim to use other than the default "," (comma). This delimiter must be one-character long.

Text will be encoded as UTF-8.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_csv_line(PackedStringArray values, String delim)

Parameters

values PackedStringArray

delim String

store_double(float)

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

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_double(float value)

Parameters

value float

store_float(float)

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

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_float(float value)

Parameters

value float

store_half(float)

Stores a half-precision floating-point number as 16 bits in the file.

bool store_half(float value)

Parameters

value float

store_line(String)

Stores line in the file followed by a newline character (\n), encoding the text as UTF-8.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_line(String line)

Parameters

line String

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

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_pascal_string(String string)

Parameters

string String

store_real(float)

Stores a floating-point number in the file.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_real(float value)

Parameters

value float

store_string(String)

Stores string in the file without a newline character (\n), encoding the text as UTF-8.

Note: This method is intended to be used to write text files. The string is stored as a UTF-8 encoded buffer without string length or terminating zero, which means that it can't be loaded back easily. If you want to store a retrievable string in a binary file, consider using FileAccess.store_pascal_string instead. For retrieving strings from a text file, you can use get_buffer(length).get_string_from_utf8() (if you know the length) or FileAccess.get_as_text.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_string(String string)

Parameters

string String

store_var(Variant, bool)

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

Internally, this uses the same encoding mechanism as the @GlobalScope.var_to_bytes method.

Note: Not all properties are included. Only properties that are configured with the @GlobalScope.PROPERTY_USAGE_STORAGE flag set will be serialized. You can add a new usage flag to a property by overriding the _get_property_list method in your class. You can also check how property usage is configured by calling _get_property_list. See PropertyUsageFlags for the possible usage flags.

Note: If an error occurs, the resulting value of the file position indicator is indeterminate.

bool store_var(Variant value, bool full_objects)

Parameters

value Variant

full_objects bool