diff options
| author | IlyaStuurFedorov <ilyastuurfedorov@gmail.com> | 2019-11-12 16:53:55 +0300 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2019-11-12 23:15:29 +0100 |
| commit | fa45fdb5f5d8435b49303ef36b33241f278b33de (patch) | |
| tree | 73205bc7a3a7e6b4912c629d2d1c7e095ac0fc9d /doc | |
| parent | 30d4c923cbe0c61bfcae4e91227d7bbdec8737c1 (diff) | |
doc: PCKPacker class example code
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/PCKPacker.xml | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml index f3091a3e3f..ff45ca925c 100644 --- a/doc/classes/PCKPacker.xml +++ b/doc/classes/PCKPacker.xml @@ -3,6 +3,14 @@ <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> @@ -15,6 +23,7 @@ <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"> |