Improve the PCKPacker class documentation
This commit is contained in:
parent
ff58030ed6
commit
7ae0e4be46
|
@ -1,16 +1,17 @@
|
||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
<class name="PCKPacker" inherits="Reference" category="Core" version="3.2">
|
<class name="PCKPacker" inherits="Reference" category="Core" version="3.2">
|
||||||
<brief_description>
|
<brief_description>
|
||||||
|
Creates packages that can be loaded into a running project.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
The [PCKPacker] is used to create packages in application runtime.
|
The [PCKPacker] is used to create packages that can be loaded into a running project using [method ProjectSettings.load_resource_pack].
|
||||||
[codeblock]
|
[codeblock]
|
||||||
var packer = PCKPacker.new()
|
var packer = PCKPacker.new()
|
||||||
packer.pck_start("test.pck", 0)
|
packer.pck_start("test.pck", 0)
|
||||||
packer.add_file("res://text.txt", "text.txt")
|
packer.add_file("res://text.txt", "text.txt")
|
||||||
packer.flush(false)
|
packer.flush(false)
|
||||||
[/codeblock]
|
[/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.
|
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>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
@ -32,6 +33,7 @@
|
||||||
<argument index="0" name="verbose" type="bool">
|
<argument index="0" name="verbose" type="bool">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Writes the files specified using all [method add_file] calls since the last flush. If [code]verbose[/code] is [code]true[/code], a list of files added will be printed to the console for easier debugging.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="pck_start">
|
<method name="pck_start">
|
||||||
|
@ -42,6 +44,7 @@
|
||||||
<argument index="1" name="alignment" type="int">
|
<argument index="1" name="alignment" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<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>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
Loading…
Reference in New Issue