asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Make some arguments in PCKPacker methods optional

Browse source 
Those arguments aren't required for most common use cases,
so making them optional should help with code readability.
This commit is contained in:
Hugo Locurcio 2019-12-07 01:05:11 +01:00
parent ff58030ed6
commit fe06966181
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
3 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
core/io/pck_packer.cpp
View file

@ -55,9 +55,9 @@ static void _pad(FileAccess *p_file, int p_bytes) {
void PCKPacker::_bind_methods() { 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("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) { Error PCKPacker::pck_start(const String &p_file, int p_alignment) {

2
core/io/pck_packer.h
View file

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

8
doc/classes/PCKPacker.xml
View file

@ -6,9 +6,9 @@
The [PCKPacker] is used to create packages in application runtime. The [PCKPacker] is used to create packages in application runtime.
[codeblock] [codeblock]
var packer = PCKPacker.new() var packer = PCKPacker.new()
packer.pck_start("test.pck", 0) packer.pck_start("test.pck")
packer.add_file("res://text.txt", "text.txt") packer.add_file("res://text.txt", "text.txt")
packer.flush(false) packer.flush()
[/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 [b]test.pck[/b], then adds a file named [b]text.txt[/b] in the root of the package.
</description> </description>
@ -29,7 +29,7 @@
<method name="flush"> <method name="flush">
<return type="int" enum="Error"> <return type="int" enum="Error">
</return> </return>
<argument index="0" name="verbose" type="bool"> <argument index="0" name="verbose" type="bool" default="false">
</argument> </argument>
<description> <description>
</description> </description>
@ -39,7 +39,7 @@
</return> </return>
<argument index="0" name="pck_name" type="String"> <argument index="0" name="pck_name" type="String">
</argument> </argument>
<argument index="1" name="alignment" type="int"> <argument index="1" name="alignment" type="int" default="0">
</argument> </argument>
<description> <description>
</description> </description>