Struct File

Type to handle file reading and writing operations.

struct File ;

File type. This is used to permanently store data into the user device's file system and to read from it. This can be used to store game save data or player configuration files, for example. Here's a sample on how to write and read from a file:

func save(content): var file = File.new() file.open("user://save_game.dat", File.WRITE) file.store_string(content) file.close()

func load(): var file = File.new() file.open("user://save_game.dat", File.READ) var content = file.get_as_text() file.close() return content

Properties

NameTypeDescription
endianSwap[get, set] boolIf true, the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines. Note: This is about the file format, not CPU type. This is always reset to false whenever you open the file.

Methods

NameDescription
close Closes the currently opened file.
eofReached Returns true if the file cursor has read past the end of the file. Note: This function will still return false while at the end of the file and only activates when reading past it. This can be confusing but it conforms to how low-level file access works in all operating systems. There is always getLen and getPosition to implement a custom logic.
fileExists Returns true if the file exists in the given path. Note: Many resources types are imported (e.g. textures or sound files), and that their source asset will not be included in the exported game, as only the imported version is used (in the res://.import folder). To check for the existence of such resources while taking into account the remapping to their imported location, use ResourceLoader.exists. Typically, using File.file_exists on an imported resource would work while you are developing in the editor (the source asset is present in res://, but fail when exported).
get16 Returns the next 16 bits from the file as an integer.
get32 Returns the next 32 bits from the file as an integer.
get64 Returns the next 64 bits from the file as an integer.
get8 Returns the next 8 bits from the file as an integer.
getAsText Returns the whole file as a String. Text is interpreted as being UTF-8 encoded.
getBuffer Returns next len bytes of the file as a PoolByteArray.
getCsvLine 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. Text is interpreted as being UTF-8 encoded.
getDouble Returns the next 64 bits from the file as a floating-point number.
getEndianSwap
getError Returns the last error that happened when trying to perform operations. Compare with the ERR_FILE_* constants from error.
getFloat Returns the next 32 bits from the file as a floating-point number.
getLen Returns the size of the file in bytes.
getLine Returns the next line of the file as a String. Text is interpreted as being UTF-8 encoded.
getMd5 Returns an MD5 String representing the file at the given path or an empty String on failure.
getModifiedTime Returns the last time the file was modified in unix timestamp format or returns a String "ERROR IN file". This unix timestamp can be converted to datetime by using OS.getDatetimeFromUnixTime.
getPascalString Returns a String saved in Pascal format from the file. Text is interpreted as being UTF-8 encoded.
getPath Returns the path as a String for the current open file.
getPathAbsolute Returns the absolute path as a String for the current open file.
getPosition Returns the file cursor's position.
getReal Returns the next bits from the file as a floating-point number.
getSha256 Returns a SHA-256 String representing the file at the given path or an empty String on failure.
getVar Returns the next Variant value from the file. If allow_objects is true, decoding objects is allowed. 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.
isOpen Returns true if the file is currently opened.
open Opens the file for writing or reading, depending on the flags.
openCompressed Opens a compressed file for reading or writing.
openEncrypted Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
openEncryptedWithPass Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
seek Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
seekEnd 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.
setEndianSwap
store16 Stores an integer as 16 bits in the file.
store32 Stores an integer as 32 bits in the file.
store64 Stores an integer as 64 bits in the file.
store8 Stores an integer as 8 bits in the file.
storeBuffer Stores the given array of bytes in the file.
storeCsvLine Store the given PoolStringArray 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.
storeDouble Stores a floating-point number as 64 bits in the file.
storeFloat Stores a floating-point number as 32 bits in the file.
storeLine Stores the given String as a line in the file. Text will be encoded as UTF-8.
storePascalString 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.
storeReal Stores a floating-point number in the file.
storeString Stores the given String in the file. Text will be encoded as UTF-8.
storeVar Stores any Variant value in the file. If full_objects is true, encoding objects is allowed (and can potentially include code).

Enums

NameDescription
CompressionMode
Constants
ModeFlags