FileAccess
Inherits:RefCounted<Object
Provides methods for file reading and writing operations.
Description
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:
funcsave_to_file(content):varfile=FileAccess.open("user://save_game.dat",FileAccess.WRITE)file.store_string(content)funcload_from_file():varfile=FileAccess.open("user://save_game.dat",FileAccess.READ)varcontent=file.get_as_text()returncontent
publicvoidSaveToFile(stringcontent){usingvarfile=FileAccess.Open("user://save_game.dat",FileAccess.ModeFlags.Write);file.StoreString(content);}publicstringLoadFromFile(){usingvarfile=FileAccess.Open("user://save_game.dat",FileAccess.ModeFlags.Read);stringcontent=file.GetAsText();returncontent;}
In the example above, the file will be saved in the user data folder as specified in theData paths documentation.
FileAccess will close when it's freed, which happens when it goes out of scope or when it gets assigned withnull.close() can be used to close it before then explicitly. In C# the reference must be disposed manually, which can be done with theusing statement or by calling theDispose method directly.
Note: To access project resources once exported, it is recommended to useResourceLoader instead ofFileAccess, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package. If usingFileAccess, make sure the file is included in the export by changing its import mode toKeep 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 pressingAlt + F4). If you stop the project execution by pressingF8 while the project is running, the file won't be closed as the game process will be killed. You can work around this by callingflush() at regular intervals.
Tutorials
Properties
Methods
Enumerations
enumModeFlags:🔗
ModeFlagsREAD =1
Opens the file for read operations. The cursor is positioned at the beginning of the file.
ModeFlagsWRITE =2
Opens the file for write operations. The file is created if it does not exist, and truncated if it does.
Note: When creating a file it must be in an already existing directory. To recursively create directories for a file path, seeDirAccess.make_dir_recursive().
ModeFlagsREAD_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.
ModeFlagsWRITE_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.
Note: When creating a file it must be in an already existing directory. To recursively create directories for a file path, seeDirAccess.make_dir_recursive().
enumCompressionMode:🔗
CompressionModeCOMPRESSION_FASTLZ =0
Uses theFastLZ compression method.
CompressionModeCOMPRESSION_DEFLATE =1
Uses theDEFLATE compression method.
CompressionModeCOMPRESSION_ZSTD =2
Uses theZstandard compression method.
CompressionModeCOMPRESSION_GZIP =3
Uses thegzip compression method.
CompressionModeCOMPRESSION_BROTLI =4
Uses thebrotli compression method (only decompression is supported).
flagsUnixPermissionFlags:🔗
UnixPermissionFlagsUNIX_READ_OWNER =256
Read for owner bit.
UnixPermissionFlagsUNIX_WRITE_OWNER =128
Write for owner bit.
UnixPermissionFlagsUNIX_EXECUTE_OWNER =64
Execute for owner bit.
UnixPermissionFlagsUNIX_READ_GROUP =32
Read for group bit.
UnixPermissionFlagsUNIX_WRITE_GROUP =16
Write for group bit.
UnixPermissionFlagsUNIX_EXECUTE_GROUP =8
Execute for group bit.
UnixPermissionFlagsUNIX_READ_OTHER =4
Read for other bit.
UnixPermissionFlagsUNIX_WRITE_OTHER =2
Write for other bit.
UnixPermissionFlagsUNIX_EXECUTE_OTHER =1
Execute for other bit.
UnixPermissionFlagsUNIX_SET_USER_ID =2048
Set user id on execution bit.
UnixPermissionFlagsUNIX_SET_GROUP_ID =1024
Set group id on execution bit.
UnixPermissionFlagsUNIX_RESTRICTED_DELETE =512
Restricted deletion (sticky) bit.
Property Descriptions
boolis_big_endian()
Iftrue, the file is read with big-endianendianness. Iffalse, the file is read with little-endian endianness. If in doubt, leave this tofalse 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 tofalse whenever you open the file. Therefore, you must setbig_endianafter opening the file, not before.
Method Descriptions
Closes the currently opened file and prevents subsequent read/write operations. Useflush() 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 withnull. In C# the reference must be disposed after we are done using it, this can be done with theusing statement or calling theDispose method directly.
FileAccesscreate_temp(mode_flags:int, prefix:String = "", extension:String = "", keep:bool = false)static🔗
Creates a temporary file. This file will be freed when the returnedFileAccess is freed.
Ifprefix is not empty, it will be prefixed to the file name, separated by a-.
Ifextension is not empty, it will be appended to the temporary file name.
Ifkeep istrue, the file is not deleted when the returnedFileAccess is freed.
Returnsnull if opening the file failed. You can useget_open_error() to check the error that occurred.
Returnstrue 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:
whilefile.get_position()<file.get_length():# Read data
while(file.GetPosition()<file.GetLength()){// Read data}
boolfile_exists(path:String)static🔗
Returnstrue 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. SeeResourceLoader.exists() for an alternative approach that takes resource remapping into account.
For a non-static, relative equivalent, useDirAccess.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 callflush() manually before closing a file. Still, callingflush() can be used to ensure the data is safe even if the project crashes instead of being closed gracefully.
Note: Only callflush() 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. Seestore_8() for details on what values can be stored and retrieved this way.
Returns the next 16 bits from the file as an integer. Seestore_16() for details on what values can be stored and retrieved this way.
Returns the next 32 bits from the file as an integer. Seestore_32() for details on what values can be stored and retrieved this way.
Returns the next 64 bits from the file as an integer. Seestore_64() for details on what values can be stored and retrieved this way.
Stringget_as_text(skip_cr:bool = false)const🔗
Returns the whole file as aString. Text is interpreted as being UTF-8 encoded.
Ifskip_cr istrue, 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).
PackedByteArrayget_buffer(length:int)const🔗
Returns nextlength bytes of the file as aPackedByteArray.
PackedStringArrayget_csv_line(delim:String = ",")const🔗
Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiterdelim 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 itcould 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 theERR_FILE_* constants fromError.
PackedByteArrayget_file_as_bytes(path:String)static🔗
Returns the wholepath file contents as aPackedByteArray without any decoding.
Returns an emptyPackedByteArray if an error occurred while opening the file. You can useget_open_error() to check the error that occurred.
Stringget_file_as_string(path:String)static🔗
Returns the wholepath file contents as aString. Text is interpreted as being UTF-8 encoded.
Returns an emptyString if an error occurred while opening the file. You can useget_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.
boolget_hidden_attribute(file:String)static🔗
Returnstrue, if filehidden 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 aString. 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.
Stringget_md5(path:String)static🔗
Returns an MD5 String representing the file at the given path or an emptyString on failure.
intget_modified_time(file:String)static🔗
Returns the last time thefile was modified in Unix timestamp format, or0 on error. This Unix timestamp can be converted to another format using theTime singleton.
Returns the result of the lastopen() call in the current thread.
Returns aString saved in Pascal format from the file.
Text is interpreted as being UTF-8 encoded.
Returns the path as aString for the current open file.
Stringget_path_absolute()const🔗
Returns the absolute path as aString for the current open file.
Returns the file cursor's position.
boolget_read_only_attribute(file:String)static🔗
Returnstrue, if filereadonly 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.
Stringget_sha256(path:String)static🔗
Returns an SHA-256String representing the file at the given path or an emptyString on failure.
BitField[UnixPermissionFlags]get_unix_permissions(file:String)static🔗
Returns file UNIX permissions.
Note: This method is implemented on iOS, Linux/BSD, and macOS.
Variantget_var(allow_objects:bool = false)const🔗
Returns the nextVariant value from the file. Ifallow_objects istrue, 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.
Returnstrue if the file is currently opened.
FileAccessopen(path:String, flags:ModeFlags)static🔗
Creates a newFileAccess object and opens the file for writing or reading, depending on the flags.
Returnsnull if opening the file failed. You can useget_open_error() to check the error that occurred.
FileAccessopen_compressed(path:String, mode_flags:ModeFlags, compression_mode:CompressionMode = 0)static🔗
Creates a newFileAccess 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. SeeGitHub issue #28999 for a workaround.
Returnsnull if opening the file failed. You can useget_open_error() to check the error that occurred.
FileAccessopen_encrypted(path:String, mode_flags:ModeFlags, key:PackedByteArray, iv:PackedByteArray = PackedByteArray())static🔗
Creates a newFileAccess 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.
Returnsnull if opening the file failed. You can useget_open_error() to check the error that occurred.
FileAccessopen_encrypted_with_pass(path:String, mode_flags:ModeFlags, pass:String)static🔗
Creates a newFileAccess object and opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
Returnsnull if opening the file failed. You can useget_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).
voidseek_end(position:int = 0)🔗
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.
Errorset_hidden_attribute(file:String, hidden:bool)static🔗
Sets filehidden attribute.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Errorset_read_only_attribute(file:String, ro:bool)static🔗
Sets fileread only attribute.
Note: This method is implemented on iOS, BSD, macOS, and Windows.
Errorset_unix_permissions(file:String, permissions:BitField[UnixPermissionFlags])static🔗
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: Thevalue 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, usestore_64(), or convert it manually (seestore_16() for an example).
Stores an integer as 16 bits in the file.
Note: Thevalue 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, usestore_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:
constMAX_15B=1<<15constMAX_16B=1<<16funcunsigned16_to_signed(unsigned):return(unsigned+MAX_15B)%MAX_16B-MAX_15Bfunc_ready():varf=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.varread1=f.get_16()# 65494varread2=f.get_16()# 121varconverted1=unsigned16_to_signed(read1)# -42varconverted2=unsigned16_to_signed(read2)# 121
publicoverridevoid_Ready(){usingvarf=FileAccess.Open("user://file.dat",FileAccess.ModeFlags.WriteRead);f.Store16(unchecked((ushort)-42));// This wraps around and stores 65494 (2^16 - 42).f.Store16(121);// In bounds, will store 121.f.Seek(0);// Go back to start to read the stored value.ushortread1=f.Get16();// 65494ushortread2=f.Get16();// 121shortconverted1=(short)read1;// -42shortconverted2=(short)read2;// 121}
Stores an integer as 32 bits in the file.
Note: Thevalue 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, usestore_64(), or convert it manually (seestore_16() for an example).
Stores an integer as 64 bits in the file.
Note: Thevalue must lie in the interval[-2^63,2^63-1] (i.e. be a validint value).
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
boolstore_buffer(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.
boolstore_csv_line(values:PackedStringArray, delim:String = ",")🔗
Store the givenPackedStringArray in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiterdelim 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.
boolstore_double(value: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.
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.
Storesline 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.
boolstore_pascal_string(string:String)🔗
Stores the givenString 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.
boolstore_string(string:String)🔗
Storesstring 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 usingstore_pascal_string() instead. For retrieving strings from a text file, you can useget_buffer(length).get_string_from_utf8() (if you know the length) orget_as_text().
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.
boolstore_var(value:Variant, full_objects:bool = false)🔗
Stores any Variant value in the file. Iffull_objects istrue, 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 theObject._get_property_list() method in your class. You can also check how property usage is configured by callingObject._get_property_list(). SeePropertyUsageFlags for the possible usage flags.
Note: If an error occurs, the resulting value of the file position indicator is indeterminate.