Up to date
This page is up to date for Godot 4.1
.
If you still find outdated information, please open an issue.
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 store game save data or player configuration files.
Here's a sample on how to write and read from a file:
func save(content):
var file = FileAccess.open("user://save_game.dat", FileAccess.WRITE)
file.store_string(content)
func load():
var file = FileAccess.open("user://save_game.dat", FileAccess.READ)
var content = file.get_as_text()
return content
public void Save(string content)
{
using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Write);
file.StoreString(content);
}
public string Load()
{
using var file = FileAccess.Open("user://save_game.dat", FileAccess.ModeFlags.Read);
string content = file.GetAsText();
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.
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.
Tutorials¶
Properties¶
Methods¶
void |
close ( ) |
eof_reached ( ) const |
|
file_exists ( String path ) static |
|
void |
flush ( ) |
get_8 ( ) const |
|
get_16 ( ) const |
|
get_32 ( ) const |
|
get_64 ( ) const |
|
get_as_text ( bool skip_cr=false ) const |
|
get_buffer ( int length ) const |
|
get_csv_line ( String delim="," ) const |
|
get_double ( ) const |
|
get_error ( ) const |
|
get_file_as_bytes ( String path ) static |
|
get_file_as_string ( String path ) static |
|
get_float ( ) const |
|
get_length ( ) const |
|
get_line ( ) const |
|
get_modified_time ( String file ) static |
|
get_open_error ( ) static |
|
get_path ( ) const |
|
get_path_absolute ( ) const |
|
get_position ( ) const |
|
get_real ( ) const |
|
get_sha256 ( String path ) static |
|
is_open ( ) const |
|
open_compressed ( String path, ModeFlags mode_flags, CompressionMode compression_mode=0 ) static |
|
open_encrypted ( String path, ModeFlags mode_flags, PackedByteArray key ) static |
|
open_encrypted_with_pass ( String path, ModeFlags mode_flags, String pass ) static |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
store_buffer ( PackedByteArray buffer ) |
void |
store_csv_line ( PackedStringArray values, String delim="," ) |
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 |
Enumerations¶
enum ModeFlags:
ModeFlags READ = 1
Opens the file for read operations. The cursor is positioned at the beginning of the file.
ModeFlags WRITE = 2
Opens the file for write operations. The file is created if it does not exist, and truncated if it does.
ModeFlags 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.
ModeFlags 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.
enum CompressionMode:
CompressionMode COMPRESSION_FASTLZ = 0
Uses the FastLZ compression method.
CompressionMode COMPRESSION_DEFLATE = 1
Uses the DEFLATE compression method.
CompressionMode COMPRESSION_ZSTD = 2
Uses the Zstandard compression method.
CompressionMode COMPRESSION_GZIP = 3
Uses the gzip compression method.
CompressionMode COMPRESSION_BROTLI = 4
Uses the brotli compression method (only decompression is supported).
Property Descriptions¶
bool 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.
Method Descriptions¶
void 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.
bool eof_reached ( ) 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:
while file.get_position() < file.get_length():
# Read data