FileAccess

There is currently no description for this class. Please help us by contributing one!

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
Error	resize ( int length )
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

There is currently no description for this enum. Please help us by contributing one!

ModeFlags WRITE = 2

There is currently no description for this enum. Please help us by contributing one!

ModeFlags READ_WRITE = 3

There is currently no description for this enum. Please help us by contributing one!

ModeFlags WRITE_READ = 7

There is currently no description for this enum. Please help us by contributing one!

enum CompressionMode:

CompressionMode COMPRESSION_FASTLZ = 0

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_DEFLATE = 1

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_ZSTD = 2

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_GZIP = 3

There is currently no description for this enum. Please help us by contributing one!

CompressionMode COMPRESSION_BROTLI = 4

There is currently no description for this enum. Please help us by contributing one!

flags UnixPermissionFlags:

UnixPermissionFlags UNIX_READ_OWNER = 256

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_WRITE_OWNER = 128

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_EXECUTE_OWNER = 64

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_READ_GROUP = 32

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_WRITE_GROUP = 16

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_EXECUTE_GROUP = 8

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_READ_OTHER = 4

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_WRITE_OTHER = 2

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_EXECUTE_OTHER = 1

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_SET_USER_ID = 2048

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_SET_GROUP_ID = 1024

There is currently no description for this enum. Please help us by contributing one!

UnixPermissionFlags UNIX_RESTRICTED_DELETE = 512

There is currently no description for this enum. Please help us by contributing one!

Property Descriptions

bool big_endian

void set_big_endian ( bool value )
bool is_big_endian ( )

There is currently no description for this property. Please help us by contributing one!