Class PCKPacker

Creates packages that can be loaded into a running project.

Inheritance

RefCounted

Object

PCKPacker

Remarks

The PCKPacker is used to create packages that can be loaded into a running project using ProjectSettings.load_resource_pack.

• gdscript
• C#

var packer = PCKPacker.new()
packer.pck_start("test.pck")
packer.add_file("res://text.txt", "text.txt")
packer.flush()

The above PCKPacker creates package test.pck, then adds a file named text.txt at the root of the package.

Note: PCK is Godot's own pack file format. To create ZIP archives that can be read by any program, use ZIPPacker instead.

Methods

add_file(String, String, bool)

Adds the source_path file to the current PCK package at the target_path internal path. The res:// prefix for target_path is optional and stripped internally.

int add_file(String target_path, String source_path, bool encrypt)

Parameters

target_path String

source_path String

encrypt bool

add_file_removal(String)

Registers a file removal of the target_path internal path to the PCK. This is mainly used for patches. If the file at this path has been loaded from a previous PCK, it will be removed. The res:// prefix for target_path is optional and stripped internally.

int add_file_removal(String target_path)

Parameters

target_path String

flush(bool)

Writes the files specified using all PCKPacker.add_file calls since the last flush. If verbose is true, a list of files added will be printed to the console for easier debugging.

int flush(bool verbose)

Parameters

verbose bool

pck_start(String, int, String, bool)

Creates a new PCK file at the file path pck_path. The .pck file extension isn't added automatically, so it should be part of pck_path (even though it's not required).

int pck_start(String pck_path, int alignment, String key, bool encrypt_directory)

Parameters

pck_path String

alignment int

key String

encrypt_directory bool