Table of Contents

Class ZipReader

Namespace
Godot
Assembly
GodotSharp.dll

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
[GodotClassName("ZIPReader")]
public class ZipReader : RefCounted, IDisposable
Inheritance
ZipReader
Implements
Inherited Members

Constructors

ZipReader() 

public ZipReader()

Methods

Close()

Closes the underlying resources used by this instance.

public Error Close()

Returns

Error

FileExists(string, bool)

Returns true if the file exists in the loaded zip archive.

Must be called after Open(string).

public bool FileExists(string path, bool caseSensitive = true)

Parameters

path string
caseSensitive bool

Returns

bool

GetFiles()

Returns the list of names of all files in the loaded archive.

Must be called after Open(string).

public string[] GetFiles()

Returns

string[]

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

Open(string)

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

public Error Open(string path)

Parameters

path string

Returns

Error

ReadFile(string, bool)

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

Must be called after Open(string).

public byte[] ReadFile(string path, bool caseSensitive = true)

Parameters

path string
caseSensitive bool

Returns

byte[]
Edit this page