godot/doc/classes/PCKPacker.xml
2019-11-12 23:15:29 +01:00

51 lines
1.5 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PCKPacker" inherits="Reference" category="Core" version="3.2">
<brief_description>
</brief_description>
<description>
The [PCKPacker] is used to create packages in application runtime.
[codeblock]
var packer = PCKPacker.new()
packer.pck_start("test.pck", 0)
packer.add_file("res://text.txt", "text.txt")
packer.flush(false)
[/codeblock]
The above [PCKPacker] creates package [b]test.pck[/b], then adds a file named [b]text.txt[/b] in the root of the package.
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_file">
<return type="int" enum="Error">
</return>
<argument index="0" name="pck_path" type="String">
</argument>
<argument index="1" name="source_path" type="String">
</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>
</method>
<method name="flush">
<return type="int" enum="Error">
</return>
<argument index="0" name="verbose" type="bool">
</argument>
<description>
</description>
</method>
<method name="pck_start">
<return type="int" enum="Error">
</return>
<argument index="0" name="pck_name" type="String">
</argument>
<argument index="1" name="alignment" type="int">
</argument>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>