Index · Object → RefCounted → ZIPPacker

ZIPPacker

Allows the creation of ZIP files.

Class Description

This class implements a writer that allows storing the multiple blobs in a ZIP archive. See also ZIPReader and PCKPacker.

# Create a ZIP archive with a single file at its root.
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

Properties

var compression_level: int = -1

The compression level used when start_file() is called. Use CompressionLevel as a reference.

Methods

func add_directory(path: String, permissions: FileAccess.UnixPermissionFlags = 493, modified_time: int = 0) -> Error

Adds directory to the archive. If modified_time is set to 0, current system time is used.

Note: Directories are automatically created when start_file() is called, use this function before adding files to create directories with custom permissions and modification time.

func close() -> Error

Closes the underlying resources used by this instance.

func close_file() -> Error

Stops writing to a file within the archive.

It will fail if there is no open file.

func open(path: String, append: ZIPPacker.ZipAppend = 0) -> Error

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

This must be called before everything else.

func start_file(path: String, permissions: FileAccess.UnixPermissionFlags = 420, modified_time: int = 0) -> Error

Starts writing to a file within the archive. Only one file can be written at the same time. If modified_time is set to 0, current system time is used.

Must be called after open().

func write_file(data: PackedByteArray) -> Error

Write the given data to the file.

Needs to be called after start_file().

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

enum ZipAppend
APPEND_CREATE = 0

Create a new zip archive at the given path.

APPEND_CREATEAFTER = 1

Append a new zip archive to the end of the already existing file at the given path.

APPEND_ADDINZIP = 2

Add new files to the existing zip archive at the given path.

enum CompressionLevel
COMPRESSION_DEFAULT = -1

Start a file with the default Deflate compression level (6). This is a good compromise between speed and file size.

COMPRESSION_NONE = 0

Start a file with no compression. This is also known as the "Store" compression mode and is the fastest method of packing files inside a ZIP archive. Consider using this mode for files that are already compressed (such as JPEG, PNG, MP3, or Ogg Vorbis files).

COMPRESSION_FAST = 1

Start a file with the fastest Deflate compression level (1). This is fast to compress, but results in larger file sizes than COMPRESSION_DEFAULT. Decompression speed is generally unaffected by the chosen compression level.

COMPRESSION_BEST = 9

Start a file with the best Deflate compression level (9). This is slow to compress, but results in smaller file sizes than COMPRESSION_DEFAULT. Decompression speed is generally unaffected by the chosen compression level.