summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHaoyu Qiu <timothyqiu32@gmail.com>2023-07-11 09:07:22 +0800
committerHaoyu Qiu <timothyqiu32@gmail.com>2023-07-11 09:27:21 +0800
commitdf1d354d36154985b9ee474528b34700791d2c5e (patch)
tree9b2d88225f720fcdd53f695efbfb3477a2fccfd5
parentef155c1aeb216fa5a732913b6f2dc321e4b512dc (diff)
downloadredot-engine-df1d354d36154985b9ee474528b34700791d2c5e.tar.gz
Clarify EditorExportPlugin::add_file only remaps in _export_file
-rw-r--r--doc/classes/EditorExportPlugin.xml3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml
index 9c185a2ddb..fa82447894 100644
--- a/doc/classes/EditorExportPlugin.xml
+++ b/doc/classes/EditorExportPlugin.xml
@@ -130,7 +130,8 @@
<param index="1" name="file" type="PackedByteArray" />
<param index="2" name="remap" type="bool" />
<description>
- Adds a custom file to be exported. [param path] is the virtual path that can be used to load the file, [param file] is the binary data of the file. If [param remap] is [code]true[/code], file will not be exported, but instead remapped to the given [param path].
+ Adds a custom file to be exported. [param path] is the virtual path that can be used to load the file, [param file] is the binary data of the file.
+ When called inside [method _export_file] and [param remap] is [code]true[/code], the current file will not be exported, but instead remapped to this custom file. [param remap] is ignored when called in other places.
</description>
</method>
<method name="add_ios_bundle_file">