summaryrefslogtreecommitdiffstats
path: root/doc/classes/PCKPacker.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/PCKPacker.xml')
-rw-r--r--doc/classes/PCKPacker.xml11
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/classes/PCKPacker.xml b/doc/classes/PCKPacker.xml
index ec0300c068..f8f7dbee01 100644
--- a/doc/classes/PCKPacker.xml
+++ b/doc/classes/PCKPacker.xml
@@ -26,11 +26,18 @@
<methods>
<method name="add_file">
<return type="int" enum="Error" />
- <param index="0" name="pck_path" type="String" />
+ <param index="0" name="target_path" type="String" />
<param index="1" name="source_path" type="String" />
<param index="2" name="encrypt" type="bool" default="false" />
<description>
- Adds the [param source_path] file to the current PCK package at the [param pck_path] internal path (should start with [code]res://[/code]).
+ Adds the [param source_path] file to the current PCK package at the [param target_path] internal path. The [code]res://[/code] prefix for [param target_path] is optional and stripped internally.
+ </description>
+ </method>
+ <method name="add_file_removal">
+ <return type="int" enum="Error" />
+ <param index="0" name="target_path" type="String" />
+ <description>
+ Registers a file removal of the [param target_path] internal path to the PCK. This is mainly used for patches. If the file at this path has been loaded from a previous PCK, it will be removed. The [code]res://[/code] prefix for [param target_path] is optional and stripped internally.
</description>
</method>
<method name="flush">