Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

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¶

bool	big_endian

Methods¶

void	close ( )
bool	eof_reached ( ) const
bool	file_exists ( String path ) static
void	flush ( )
int	get_8 ( ) const
int	get_16 ( ) const
int	get_32 ( ) const
int	get_64 ( ) const
String	get_as_text ( bool skip_cr=false ) const
PackedByteArray	get_buffer ( int length ) const
PackedStringArray	get_csv_line ( String delim="," ) const
float	get_double ( ) const
Error	get_error ( ) const
PackedByteArray	get_file_as_bytes ( String path ) static
String	get_file_as_string ( String path ) static
float	get_float ( ) const
bool	get_hidden_attribute ( String file ) static
int	get_length ( ) const
String	get_line ( ) const
String	get_md5 ( String path ) static
int	get_modified_time ( String file ) static
Error	get_open_error ( ) static
String	get_pascal_string ( )
String	get_path ( ) const
String	get_path_absolute ( ) const
int	get_position ( ) const
bool	get_read_only_attribute ( String file ) static
float	get_real ( ) const
String	get_sha256 ( String path ) static
BitField<UnixPermissionFlags>	get_unix_permissions ( String file ) static
Variant	get_var ( bool allow_objects=false ) const
bool	is_open ( ) const
FileAccess	open ( String path, ModeFlags flags ) static
FileAccess	open_compressed ( String path, ModeFlags mode_flags, CompressionMode compression_mode=0 ) static
FileAccess	open_encrypted ( String path, ModeFlags mode_flags, PackedByteArray key ) static
FileAccess	open_encrypted_with_pass ( String path, ModeFlags mode_flags, String pass ) static
void	seek ( int position )
void	seek_end ( int position=0 )
Error	set_hidden_attribute ( String file, bool hidden ) static
Error	set_read_only_attribute ( String file, bool ro ) static
Error	set_unix_permissions ( String file, BitField<UnixPermissionFlags> permissions ) static
void	store_8 ( int value )
void	store_16 ( int value )
void	store_32 ( int value )
void	store_64 ( int value )
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	store_var ( Variant value, bool full_objects=false )

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

flags UnixPermissionFlags:

UnixPermissionFlags UNIX_READ_OWNER = 256

Read for owner bit.

UnixPermissionFlags UNIX_WRITE_OWNER = 128

Write for owner bit.

UnixPermissionFlags UNIX_EXECUTE_OWNER = 64

Execute for owner bit.

UnixPermissionFlags UNIX_READ_GROUP = 32

Read for group bit.

UnixPermissionFlags UNIX_WRITE_GROUP = 16

Write for group bit.

UnixPermissionFlags UNIX_EXECUTE_GROUP = 8

Execute for group bit.

UnixPermissionFlags UNIX_READ_OTHER = 4

Read for other bit.

UnixPermissionFlags UNIX_WRITE_OTHER = 2

Write for other bit.

UnixPermissionFlags UNIX_EXECUTE_OTHER = 1

Execute for other bit.

UnixPermissionFlags UNIX_SET_USER_ID = 2048

Set user id on execution bit.

UnixPermissionFlags UNIX_SET_GROUP_ID = 1024

Set group id on execution bit.

UnixPermissionFlags UNIX_RESTRICTED_DELETE = 512

Restricted deletion (sticky) bit.