Outdated documentation
This documentation page refers to Godot
4.3,
and may be outdated or incorrect.
Additionally, this engine version is
no longer supported.
Check this page in the stable branch for the latest additions and corrections.
ZIPReader
Inherits: RefCounted < Object
Allows reading the content of a zip file.
Description
This class implements a reader that can extract the content of individual files inside a zip archive.
func read_zip_file():
var reader := ZIPReader.new()
var err := reader.open("user://archive.zip")
if err != OK:
return PackedByteArray()
var res := reader.read_file("hello.txt")
reader.close()
return res
Methods
close() |
|
file_exists(path: String, case_sensitive: bool = true) |
|
Method Descriptions
Closes the underlying resources used by this instance.
bool file_exists(path: String, case_sensitive: bool = true) 🔗
Returns true if the file exists in the loaded zip archive.
Must be called after open.
PackedStringArray get_files() 🔗
Returns the list of names of all files in the loaded archive.
Must be called after open.
Opens the zip archive at the given path and reads its file index.
PackedByteArray read_file(path: String, case_sensitive: bool = true) 🔗
Loads the whole content of a file in the loaded zip archive into memory and returns it.
Must be called after open.