NEWS
COMMUNITY
STORE
TUTORIALS
ROKOJORI
NEWSLETTER
SIGN UPLOGIN
LOGOUTNEWS
COMMUNITY
STORE
TUTORIALS
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:
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.
READ = 1
Opens the file for read operations. The cursor is positioned at the beginning of the file.
WRITE = 2
Opens the file for write operations. The file is created if it does not exist, and truncated if it does.
READ_WRITE = 3
Opens the file for read and write operations. Does not truncate the file. The cursor is positioned at the beginning of the file.
WRITE_READ = 7
Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file.
COMPRESSION_FASTLZ = 0
Uses the FastLZ compression method.
COMPRESSION_DEFLATE = 1
Uses the DEFLATE compression method.
COMPRESSION_ZSTD = 2
Uses the Zstandard compression method.
COMPRESSION_GZIP = 3
Uses the gzip compression method.
COMPRESSION_BROTLI = 4
Uses the brotli compression method (only decompression is supported).
UNIX_READ_OWNER = 256
Read for owner bit.
UNIX_WRITE_OWNER = 128
Write for owner bit.
UNIX_EXECUTE_OWNER = 64
Execute for owner bit.
UNIX_READ_GROUP = 32
Read for group bit.
UNIX_WRITE_GROUP = 16
Write for group bit.
UNIX_EXECUTE_GROUP = 8
Execute for group bit.
UNIX_READ_OTHER = 4
Read for other bit.
UNIX_WRITE_OTHER = 2
Write for other bit.
UNIX_EXECUTE_OTHER = 1
Execute for other bit.
UNIX_SET_USER_ID = 2048
Set user id on execution bit.
UNIX_SET_GROUP_ID = 1024
Set group id on execution bit.
UNIX_RESTRICTED_DELETE = 512
Restricted deletion (sticky) bit.
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.
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.
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.
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:
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().
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.
Returns the next 8 bits from the file as an integer. See store_8() for details on what values can be stored and retrieved this way.
Returns the next 16 bits from the file as an integer. See store_16() for details on what values can be stored and retrieved this way.
Returns the next 32 bits from the file as an integer. See store_32() for details on what values can be stored and retrieved this way.
Returns the next 64 bits from the file as an integer. See store_64() for details on what values can be stored and retrieved this way.
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).
Returns next length 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 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:
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.
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 ERR_FILE_* constants from Error.
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.
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.
Returns the next 32 bits from the file as a floating-point number.
Returns the next 16 bits from the file as a half-precision floating-point number.
Returns true, if file hidden attribute is set.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Returns the size of the file in bytes. For a pipe, returns the number of bytes available for reading from the pipe.
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.
Returns an MD5 String representing the file at the given path or an empty String on failure.
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.
Returns the result of the last open() call in the current thread.
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 true, if file read only attribute is set.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Returns the next bits from the file as a floating-point number.
Returns an SHA-256 String representing the file at the given path or an empty String on failure.
Returns file UNIX permissions.
Note: This method is implemented on iOS, Linux/BSD, and macOS.
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.
Returns true if the file is currently opened.
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.
Creates a new FileAccess object and opens a compressed file for reading or writing.
Note: 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.
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.
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.
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.
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).
Note: This is an offset, so you should use negative numbers or the cursor will be at the end of the file.
Sets file hidden attribute.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Sets file read only attribute.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Sets file UNIX permissions.
Note: This method is implemented on iOS, Linux/BSD, and macOS.
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 store_64(), or convert it manually (see store_16() for an example).
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 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:
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 store_64(), or convert it manually (see store_16() for an example).
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.
Stores the given array of bytes in the file.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
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.
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.
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.
Stores a half-precision floating-point number as 16 bits in the file.
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.
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.
Stores a floating-point number in the file.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
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 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 get_as_text().
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
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 Object._get_property_list() method in your class. You can also check how property usage is configured by calling Object._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.
