doc: PCKPacker class example code

This commit is contained in:
IlyaStuurFedorov 2019-11-12 16:53:55 +03:00 committed by Rémi Verschelde
parent 30d4c923cb
commit fa45fdb5f5
1 changed files with 9 additions and 0 deletions

View File

@ -3,6 +3,14 @@
<brief_description> <brief_description>
</brief_description> </brief_description>
<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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -15,6 +23,7 @@
<argument index="1" name="source_path" type="String"> <argument index="1" name="source_path" type="String">
</argument> </argument>
<description> <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> </description>
</method> </method>
<method name="flush"> <method name="flush">