Merge pull request #34164 from Calinou/pckpacker-optional-args

Make some arguments in PCKPacker methods optional
This commit is contained in:
Rémi Verschelde 2019-12-09 09:41:52 +01:00 committed by GitHub
commit 3684810a28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 7 deletions

View file

@ -55,9 +55,9 @@ static void _pad(FileAccess *p_file, int p_bytes) {
void PCKPacker::_bind_methods() {
ClassDB::bind_method(D_METHOD("pck_start", "pck_name", "alignment"), &PCKPacker::pck_start);
ClassDB::bind_method(D_METHOD("pck_start", "pck_name", "alignment"), &PCKPacker::pck_start, DEFVAL(0));
ClassDB::bind_method(D_METHOD("add_file", "pck_path", "source_path"), &PCKPacker::add_file);
ClassDB::bind_method(D_METHOD("flush", "verbose"), &PCKPacker::flush);
ClassDB::bind_method(D_METHOD("flush", "verbose"), &PCKPacker::flush, DEFVAL(false));
};
Error PCKPacker::pck_start(const String &p_file, int p_alignment) {

View file

@ -54,7 +54,7 @@ class PCKPacker : public Reference {
Vector<File> files;
public:
Error pck_start(const String &p_file, int p_alignment);
Error pck_start(const String &p_file, int p_alignment = 0);
Error add_file(const String &p_file, const String &p_src);
Error flush(bool p_verbose = false);

View file

@ -7,9 +7,9 @@
The [PCKPacker] is used to create packages that can be loaded into a running project using [method ProjectSettings.load_resource_pack].
[codeblock]
var packer = PCKPacker.new()
packer.pck_start("test.pck", 0)
packer.pck_start("test.pck")
packer.add_file("res://text.txt", "text.txt")
packer.flush(false)
packer.flush()
[/codeblock]
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>
@ -30,7 +30,7 @@
<method name="flush">
<return type="int" enum="Error">
</return>
<argument index="0" name="verbose" type="bool">
<argument index="0" name="verbose" type="bool" default="false">
</argument>
<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.
@ -41,7 +41,7 @@
</return>
<argument index="0" name="pck_name" type="String">
</argument>
<argument index="1" name="alignment" type="int">
<argument index="1" name="alignment" type="int" default="0">
</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).