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 Godot.
Checking the stable version of the documentation...
PCKPacker
Успадковує: RefCounted < Object
Створює пакети, які можуть бути завантажені в запущений проект.
Опис
PCKPacker використовується для створення пакетів, які можна завантажити в запущений проект за допомогою 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();
Наведений вище PCKPacker створює пакет test.pck, а потім додає файл із назвою text.txt у кореневій папці пакета.
Примітка: PCK — це власний формат файлу пакету Godot. Щоб створити ZIP-архіви, які можна прочитати будь-якою програмою, замість цього використовуйте ZIPPacker.
Методи
add_file(target_path: String, source_path: String, encrypt: bool = false) |
|
add_file_from_buffer(target_path: String, data: PackedByteArray, encrypt: bool = false) |
|
add_file_removal(target_path: String) |
|
pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false) |
Описи методів
Error add_file(target_path: String, source_path: String, encrypt: bool = false) 🔗
Додає файл source_path до поточного пакета PCK за внутрішнім шляхом target_path. Префікс res:// для target_path є необов'язковим та видаляється внутрішньо. Вміст файлу негайно записується до PCK.
Error add_file_from_buffer(target_path: String, data: PackedByteArray, encrypt: bool = false) 🔗
Додає data до поточного пакета PCK за внутрішнім шляхом target_path. Префікс res:// для target_path є необов’язковим і видаляється внутрішньо. Вміст файлу негайно записується до PCK.
Error add_file_removal(target_path: String) 🔗
Реєструє видалення файлу внутрішнього шляху target_path до PCK. Це в основному використовується для патчів. Якщо файл за цим шляхом було завантажено з попереднього PCK, його буде видалено. Префікс res:// для target_path є необов’язковим і видаляється внутрішньо.
Error flush(verbose: bool = false) 🔗
Записує файловий каталог та закриває PCK. Якщо verbose має значення true, список доданих файлів буде виведено на консоль для легшого налагодження.
Примітка: PCKPacker автоматично очищується після звільнення, що відбувається, коли він виходить за межі області видимості або коли йому присвоюється значення null. У C# посилання має бути видалено після використання, або за допомогою оператора using, або шляхом безпосереднього виклику методу Dispose.
Error pck_start(pck_path: String, alignment: int = 32, key: String = "0000000000000000000000000000000000000000000000000000000000000000", encrypt_directory: bool = false) 🔗
Створює новий файл PCK на шляху до файлу pck_path. Розширення файлу .pck не додається автоматично, тому воно має бути частиною pck_path (хоча це не обов’язково).