path: root/doc/classes/File.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="File" inherits="Reference" version="4.0">
	<brief_description>
		Type to handle file reading and writing operations.
	</brief_description>
	<description>
		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:
		[codeblock]
		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
		[/codeblock]
		In the example above, the file will be saved in the user data folder as specified in the [url=https://docs.godotengine.org/en/latest/tutorials/io/data_paths.html]Data paths[/url] documentation.
		[b]Note:[/b] To access project resources once exported, it is recommended to use [ResourceLoader] instead of the [File] API, as some files are converted to engine-specific formats and their original source files might not be present in the exported PCK package.
	</description>
	<tutorials>
		<link title="File system">https://docs.godotengine.org/en/latest/getting_started/step_by_step/filesystem.html</link>
		<link title="3D Voxel Demo">https://godotengine.org/asset-library/asset/676</link>
	</tutorials>
	<methods>
		<method name="close">
			<return type="void">
			</return>
			<description>
				Closes the currently opened file.
			</description>
		</method>
		<method name="eof_reached" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the file cursor has read past the end of the file.
				[b]Note:[/b] This function will still return [code]false[/code] 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 [method get_len] and [method get_position] to implement a custom logic.
			</description>
		</method>
		<method name="file_exists" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Returns [code]true[/code] if the file exists in the given path.
				[b]Note:[/b] 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. See [method ResourceLoader.exists] for an alternative approach that takes resource remapping into account.
			</description>
		</method>
		<method name="get_16" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the next 16 bits from the file as an integer. See [method store_16] for details on what values can be stored and retrieved this way.
			</description>
		</method>
		<method name="get_32" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the next 32 bits from the file as an integer. See [method store_32] for details on what values can be stored and retrieved this way.
			</description>
		</method>
		<method name="get_64" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the next 64 bits from the file as an integer. See [method store_64] for details on what values can be stored and retrieved this way.
			</description>
		</method>
		<method name="get_8" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the next 8 bits from the file as an integer. See [method store_8] for details on what values can be stored and retrieved this way.
			</description>
		</method>
		<method name="get_as_text" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the whole file as a [String].
				Text is interpreted as being UTF-8 encoded.
			</description>
		</method>
		<method name="get_buffer" qualifiers="const">
			<return type="PackedByteArray">
			</return>
			<argument index="0" name="len" type="int">
			</argument>
			<description>
				Returns next [code]len[/code] bytes of the file as a [PackedByteArray].
			</description>
		</method>
		<method name="get_csv_line" qualifiers="const">
			<return type="PackedStringArray">
			</return>
			<argument index="0" name="delim" type="String" default="&quot;,&quot;">
			</argument>
			<description>
				Returns the next value of the file in CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
				Text is interpreted as being UTF-8 encoded.
			</description>
		</method>
		<method name="get_double" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns the next 64 bits from the file as a floating-point number.
			</description>
		</method>
		<method name="get_error" qualifiers="const">
			<return type="int" enum="Error">
			</return>
			<description>
				Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [enum Error].
			</description>
		</method>
		<method name="get_float" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns the next 32 bits from the file as a floating-point number.
			</description>
		</method>
		<method name="get_len" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the size of the file in bytes.
			</description>
		</method>
		<method name="get_line" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the next line of the file as a [String].
				Text is interpreted as being UTF-8 encoded.
			</description>
		</method>
		<method name="get_md5" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Returns an MD5 String representing the file at the given path or an empty [String] on failure.
			</description>
		</method>
		<method name="get_modified_time" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="file" type="String">
			</argument>
			<description>
				Returns the last time the [code]file[/code] was modified in unix timestamp format or returns a [String] "ERROR IN [code]file[/code]". This unix timestamp can be converted to datetime by using [method OS.get_datetime_from_unix_time].
			</description>
		</method>
		<method name="get_pascal_string">
			<return type="String">
			</return>
			<description>
				Returns a [String] saved in Pascal format from the file.
				Text is interpreted as being UTF-8 encoded.
			</description>
		</method>
		<method name="get_path" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the path as a [String] for the current open file.
			</description>
		</method>
		<method name="get_path_absolute" qualifiers="const">
			<return type="String">
			</return>
			<description>
				Returns the absolute path as a [String] for the current open file.
			</description>
		</method>
		<method name="get_position" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the file cursor's position.
			</description>
		</method>
		<method name="get_real" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Returns the next bits from the file as a floating-point number.
			</description>
		</method>
		<method name="get_sha256" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<description>
				Returns a SHA-256 [String] representing the file at the given path or an empty [String] on failure.
			</description>
		</method>
		<method name="get_var" qualifiers="const">
			<return type="Variant">
			</return>
			<argument index="0" name="allow_objects" type="bool" default="false">
			</argument>
			<description>
				Returns the next [Variant] value from the file. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed.
				[b]Warning:[/b] 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.
			</description>
		</method>
		<method name="is_open" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns [code]true[/code] if the file is currently opened.
			</description>
		</method>
		<method name="open">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<argument index="1" name="flags" type="int" enum="File.ModeFlags">
			</argument>
			<description>
				Opens the file for writing or reading, depending on the flags.
			</description>
		</method>
		<method name="open_compressed">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
			</argument>
			<argument index="2" name="compression_mode" type="int" enum="File.CompressionMode" default="0">
			</argument>
			<description>
				Opens a compressed file for reading or writing.
			</description>
		</method>
		<method name="open_encrypted">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
			</argument>
			<argument index="2" name="key" type="PackedByteArray">
			</argument>
			<description>
				Opens an encrypted file in write or read mode. You need to pass a binary key to encrypt/decrypt it.
				[b]Note:[/b] The provided key must be 32 bytes long.
			</description>
		</method>
		<method name="open_encrypted_with_pass">
			<return type="int" enum="Error">
			</return>
			<argument index="0" name="path" type="String">
			</argument>
			<argument index="1" name="mode_flags" type="int" enum="File.ModeFlags">
			</argument>
			<argument index="2" name="pass" type="String">
			</argument>
			<description>
				Opens an encrypted file in write or read mode. You need to pass a password to encrypt/decrypt it.
			</description>
		</method>
		<method name="seek">
			<return type="void">
			</return>
			<argument index="0" name="position" type="int">
			</argument>
			<description>
				Changes the file reading/writing cursor to the specified position (in bytes from the beginning of the file).
			</description>
		</method>
		<method name="seek_end">
			<return type="void">
			</return>
			<argument index="0" name="position" type="int" default="0">
			</argument>
			<description>
				Changes the file reading/writing cursor to the specified position (in bytes from the end of the file).
				[b]Note:[/b] This is an offset, so you should use negative numbers or the cursor will be at the end of the file.
			</description>
		</method>
		<method name="store_16">
			<return type="void">
			</return>
			<argument index="0" name="value" type="int">
			</argument>
			<description>
				Stores an integer as 16 bits in the file.
				[b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^16 - 1][/code]. Any other value will overflow and wrap around.
				To store a signed integer, use [method store_64] or store a signed integer from the interval [code][-2^15, 2^15 - 1][/code] (i.e. keeping one bit for the signedness) and compute its sign manually when reading. For example:
				[codeblock]
				const MAX_15B = 1 &lt;&lt; 15
				const MAX_16B = 1 &lt;&lt; 16

				func unsigned16_to_signed(unsigned):
				    return (unsigned + MAX_15B) % MAX_16B - MAX_15B

				func _ready():
				    var f = File.new()
				    f.open("user://file.dat", File.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.
				    var read1 = f.get_16() # 65494
				    var read2 = f.get_16() # 121
				    var converted1 = unsigned16_to_signed(read1) # -42
				    var converted2 = unsigned16_to_signed(read2) # 121
				[/codeblock]
			</description>
		</method>
		<method name="store_32">
			<return type="void">
			</return>
			<argument index="0" name="value" type="int">
			</argument>
			<description>
				Stores an integer as 32 bits in the file.
				[b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 2^32 - 1][/code]. Any other value will overflow and wrap around.
				To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example).
			</description>
		</method>
		<method name="store_64">
			<return type="void">
			</return>
			<argument index="0" name="value" type="int">
			</argument>
			<description>
				Stores an integer as 64 bits in the file.
				[b]Note:[/b] The [code]value[/code] must lie in the interval [code][-2^63, 2^63 - 1][/code] (i.e. be a valid [int] value).
			</description>
		</method>
		<method name="store_8">
			<return type="void">
			</return>
			<argument index="0" name="value" type="int">
			</argument>
			<description>
				Stores an integer as 8 bits in the file.
				[b]Note:[/b] The [code]value[/code] should lie in the interval [code][0, 255][/code]. Any other value will overflow and wrap around.
				To store a signed integer, use [method store_64], or convert it manually (see [method store_16] for an example).
			</description>
		</method>
		<method name="store_buffer">
			<return type="void">
			</return>
			<argument index="0" name="buffer" type="PackedByteArray">
			</argument>
			<description>
				Stores the given array of bytes in the file.
			</description>
		</method>
		<method name="store_csv_line">
			<return type="void">
			</return>
			<argument index="0" name="values" type="PackedStringArray">
			</argument>
			<argument index="1" name="delim" type="String" default="&quot;,&quot;">
			</argument>
			<description>
				Store the given [PackedStringArray] in the file as a line formatted in the CSV (Comma-Separated Values) format. You can pass a different delimiter [code]delim[/code] to use other than the default [code]","[/code] (comma). This delimiter must be one-character long.
				Text will be encoded as UTF-8.
			</description>
		</method>
		<method name="store_double">
			<return type="void">
			</return>
			<argument index="0" name="value" type="float">
			</argument>
			<description>
				Stores a floating-point number as 64 bits in the file.
			</description>
		</method>
		<method name="store_float">
			<return type="void">
			</return>
			<argument index="0" name="value" type="float">
			</argument>
			<description>
				Stores a floating-point number as 32 bits in the file.
			</description>
		</method>
		<method name="store_line">
			<return type="void">
			</return>
			<argument index="0" name="line" type="String">
			</argument>
			<description>
				Appends [code]line[/code] to the file followed by a line return character ([code]\n[/code]), encoding the text as UTF-8.
			</description>
		</method>
		<method name="store_pascal_string">
			<return type="void">
			</return>
			<argument index="0" name="string" type="String">
			</argument>
			<description>
				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.
			</description>
		</method>
		<method name="store_real">
			<return type="void">
			</return>
			<argument index="0" name="value" type="float">
			</argument>
			<description>
				Stores a floating-point number in the file.
			</description>
		</method>
		<method name="store_string">
			<return type="void">
			</return>
			<argument index="0" name="string" type="String">
			</argument>
			<description>
				Appends [code]string[/code] to the file without a line return, encoding the text as UTF-8.
			</description>
		</method>
		<method name="store_var">
			<return type="void">
			</return>
			<argument index="0" name="value" type="Variant">
			</argument>
			<argument index="1" name="full_objects" type="bool" default="false">
			</argument>
			<description>
				Stores any Variant value in the file. If [code]full_objects[/code] is [code]true[/code], encoding objects is allowed (and can potentially include code).
			</description>
		</method>
	</methods>
	<members>
		<member name="endian_swap" type="bool" setter="set_endian_swap" getter="get_endian_swap" default="false">
			If [code]true[/code], the file's endianness is swapped. Use this if you're dealing with files written on big-endian machines.
			[b]Note:[/b] This is about the file format, not CPU type. This is always reset to [code]false[/code] whenever you open the file.
		</member>
	</members>
	<constants>
		<constant name="READ" value="1" enum="ModeFlags">
			Opens the file for read operations. The cursor is positioned at the beginning of the file.
		</constant>
		<constant name="WRITE" value="2" enum="ModeFlags">
			Opens the file for write operations. The file is created if it does not exist, and truncated if it does.
		</constant>
		<constant name="READ_WRITE" value="3" enum="ModeFlags">
			Opens the file for read and write operations. Does not truncate the file. The cursor is positioned at the beginning of the file.
		</constant>
		<constant name="WRITE_READ" value="7" enum="ModeFlags">
			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.
		</constant>
		<constant name="COMPRESSION_FASTLZ" value="0" enum="CompressionMode">
			Uses the [url=http://fastlz.org/]FastLZ[/url] compression method.
		</constant>
		<constant name="COMPRESSION_DEFLATE" value="1" enum="CompressionMode">
			Uses the [url=https://en.wikipedia.org/wiki/DEFLATE]DEFLATE[/url] compression method.
		</constant>
		<constant name="COMPRESSION_ZSTD" value="2" enum="CompressionMode">
			Uses the [url=https://facebook.github.io/zstd/]Zstandard[/url] compression method.
		</constant>
		<constant name="COMPRESSION_GZIP" value="3" enum="CompressionMode">
			Uses the [url=https://www.gzip.org/]gzip[/url] compression method.
		</constant>
	</constants>
</class>