summaryrefslogtreecommitdiff
path: root/doc/classes/PCKPacker.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PCKPacker.xml')
-rw-r--r--doc/classes/PCKPacker.xml18
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml
index 314869be49..e3c78e08f1 100644
--- a/doc/classes/PCKPacker.xml
+++ b/doc/classes/PCKPacker.xml
@@ -5,12 +5,20 @@
</brief_description>
<description>
The [PCKPacker] is used to create packages that can be loaded into a running project using [method ProjectSettings.load_resource_pack].
- [codeblock]
+ [codeblocks]
+ [gdscript]
var packer = PCKPacker.new()
packer.pck_start("test.pck")
packer.add_file("res://text.txt", "text.txt")
packer.flush()
- [/codeblock]
+ [/gdscript]
+ [csharp]
+ var packer = new PCKPacker();
+ packer.PckStart("test.pck");
+ packer.AddFile("res://text.txt", "text.txt");
+ packer.Flush();
+ [/csharp]
+ [/codeblocks]
The above [PCKPacker] creates package [code]test.pck[/code], then adds a file named [code]text.txt[/code] at the root of the package.
</description>
<tutorials>
@@ -23,6 +31,8 @@
</argument>
<argument index="1" name="source_path" type="String">
</argument>
+ <argument index="2" name="encrypt" type="bool" default="false">
+ </argument>
<description>
Adds the [code]source_path[/code] file to the current PCK package at the [code]pck_path[/code] internal path (should start with [code]res://[/code]).
</description>
@@ -43,6 +53,10 @@
</argument>
<argument index="1" name="alignment" type="int" default="0">
</argument>
+ <argument index="2" name="key" type="String" default="&quot;&quot;">
+ </argument>
+ <argument index="3" name="encrypt_directory" type="bool" default="false">
+ </argument>
<description>
Creates a new PCK file with the name [code]pck_name[/code]. The [code].pck[/code] file extension isn't added automatically, so it should be part of [code]pck_name[/code] (even though it's not required).
</description>