Table of Contents

Class ZipPacker

Namespace
Godot
Assembly
GodotSharp.dll

This class implements a writer that allows storing the multiple blobs in a zip archive.

func write_zip_file():
      var writer := ZIPPacker.new()
      var err := writer.open("user://archive.zip")
      if err != OK:
          return err
      writer.start_file("hello.txt")
      writer.write_file("Hello World".to_utf8_buffer())
      writer.close_file()

  writer.close()
  return OK</code></pre>




[GodotClassName("ZIPPacker")]
public class ZipPacker : RefCounted, IDisposable
Inheritance
ZipPacker
Implements
Inherited Members

Constructors

ZipPacker() 

public ZipPacker()

Methods

Close()

Closes the underlying resources used by this instance.

public Error Close()

Returns

Error

CloseFile()

Stops writing to a file within the archive.

It will fail if there is no open file.

public Error CloseFile()

Returns

Error

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, ZipAppend)

Opens a zip file for writing at the given path using the specified write mode.

This must be called before everything else.

public Error Open(string path, ZipPacker.ZipAppend append = ZipAppend.Create)

Parameters

path string
append ZipPacker.ZipAppend

Returns

Error

StartFile(string)

Starts writing to a file within the archive. Only one file can be written at the same time.

Must be called after Open(string, ZipAppend).

public Error StartFile(string path)

Parameters

path string

Returns

Error

WriteFile(byte[])

Write the given data to the file.

Needs to be called after StartFile(string).

public Error WriteFile(byte[] data)

Parameters

data byte[]

Returns

Error
Edit this page