summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-12-09 09:41:52 +0100
committerGitHub <noreply@github.com>2019-12-09 09:41:52 +0100
commit3684810a283780d1c691b3e5bd78e0e36b869fc6 (patch)
tree2cb90bce414171b680f01e722237982ec186cc87 /doc
parent694abff2c67e28ef460377e1f572961e09e26ae1 (diff)
parentfe0696618163de1f329ce380612ed133af58a498 (diff)
Merge pull request #34164 from Calinou/pckpacker-optional-args
Make some arguments in PCKPacker methods optional
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/PCKPacker.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml
index a90f98ee39..e9ff2c0916 100644
--- a/doc/classes/PCKPacker.xml
+++ b/doc/classes/PCKPacker.xml
@@ -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).