2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 08:08:05 +00:00
<class name= "PCKPacker" inherits= "RefCounted" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-12 20:42:36 +00:00
<brief_description >
2019-12-06 23:38:34 +00:00
Creates packages that can be loaded into a running project.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2019-12-06 23:38:34 +00:00
The [PCKPacker] is used to create packages that can be loaded into a running project using [method ProjectSettings.load_resource_pack].
2020-10-31 17:54:17 +00:00
[codeblocks]
[gdscript]
2019-11-12 13:53:55 +00:00
var packer = PCKPacker.new()
2019-12-07 00:05:11 +00:00
packer.pck_start("test.pck")
2019-11-12 13:53:55 +00:00
packer.add_file("res://text.txt", "text.txt")
2019-12-07 00:05:11 +00:00
packer.flush()
2020-10-31 17:54:17 +00:00
[/gdscript]
[csharp]
2024-03-20 12:39:00 +00:00
var packer = new PckPacker();
2020-10-31 17:54:17 +00:00
packer.PckStart("test.pck");
packer.AddFile("res://text.txt", "text.txt");
packer.Flush();
[/csharp]
[/codeblocks]
2019-12-06 23:38:34 +00:00
The above [PCKPacker] creates package [code]test.pck[/code], then adds a file named [code]text.txt[/code] at the root of the package.
2017-09-12 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_file" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "Error" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "pck_path" type= "String" />
<param index= "1" name= "source_path" type= "String" />
<param index= "2" name= "encrypt" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-11 17:52:19 +00:00
Adds the [param source_path] file to the current PCK package at the [param pck_path] internal path (should start with [code]res://[/code]).
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "flush" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "Error" />
2022-08-06 18:11:48 +00:00
<param index= "0" name= "verbose" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2022-08-11 17:52:19 +00:00
Writes the files specified using all [method add_file] calls since the last flush. If [param verbose] is [code]true[/code], a list of files added will be printed to the console for easier debugging.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "pck_start" >
2021-07-30 13:28:05 +00:00
<return type= "int" enum= "Error" />
2024-09-21 15:56:40 +00:00
<param index= "0" name= "pck_path" type= "String" />
2022-08-06 18:11:48 +00:00
<param index= "1" name= "alignment" type= "int" default= "32" />
<param index= "2" name= "key" type= "String" default= ""0000000000000000000000000000000000000000000000000000000000000000"" />
<param index= "3" name= "encrypt_directory" type= "bool" default= "false" />
2017-09-12 20:42:36 +00:00
<description >
2024-09-21 15:56:40 +00:00
Creates a new PCK file at the file path [param pck_path]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [param pck_path] (even though it's not required).
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
</class>