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

ZIPReader

Inherits: RefCounted < Object

Allows reading the content of a zip file.

描述

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

Error	close ( )
bool	file_exists ( String path, bool case_sensitive=true )
PackedStringArray	get_files ( )
Error	open ( String path )
PackedByteArray	read_file ( String path, bool case_sensitive=true )

---

Method Descriptions

Error close ( )

Closes the underlying resources used by this instance.

---

bool file_exists ( String path, bool case_sensitive=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.

---

Error open ( String path )

Opens the zip archive at the given path and reads its file index.

---

PackedByteArray read_file ( String path, bool case_sensitive=true )

Loads the whole content of a file in the loaded zip archive into memory and returns it.

Must be called after open.