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 Redot.
Checking the stable version of the documentation...
PCKPacker¶
Inherits: RefCounted < Object
Creates packages that can be loaded into a running project.
Description¶
The PCKPacker is used to create packages that can be loaded into a running project using ProjectSettings.load_resource_pack.
var packer = PCKPacker.new()
packer.pck_start("test.pck")
packer.add_file("res://text.txt", "text.txt")
packer.flush()
var packer = new PckPacker();
packer.PckStart("test.pck");
packer.AddFile("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.
Methods¶
add_file(pck_path: String, source_path: String, encrypt: bool = false) |
|
pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false) |
Method Descriptions¶
Error add_file(pck_path: String, source_path: String, encrypt: bool = false) 🔗
Adds the source_path
file to the current PCK package at the pck_path
internal path (should start with res://
).
Error flush(verbose: bool = false) 🔗
Writes the files specified using all 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.
Error pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false) 🔗
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).