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

Complete documentation of EditorExportPlugin

Browse source 
(cherry picked from commit 8b231aff28)
This commit is contained in:
kobewi 2020-12-29 12:23:29 +01:00 committed by Rémi Verschelde
parent 10cc044ea5
commit 151fa897fb
No known key found for this signature in database
GPG key ID: C3336907360768E1
2 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
doc/classes/EditorExportPlugin.xml
View file

@ -1,9 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorExportPlugin" inherits="Reference" version="3.2">
<brief_description>
A script that is executed when exporting projects.
A script that is executed when exporting the project.
</brief_description>
<description>
Editor export plugins are automatically activated whenever the user exports the project. Their most common use is to determine what files are being included in the exported project. For each plugin, [method _export_begin] is called at the beginning of the export process and then [method _export_file] is called for each exported file.
</description>
<tutorials>
</tutorials>
@ -20,7 +21,7 @@
<argument index="3" name="flags" type="int">
</argument>
<description>
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export.
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [code]features[/code] is the list of features for the export, [code]is_debug[/code] is [code]true[/code] for debug builds, [code]path[/code] is the target path for the exported project. [code]flags[/code] is only used when running a runnable profile, e.g. when using native run on Android.
</description>
</method>
<method name="_export_end" qualifiers="virtual">
@ -40,6 +41,8 @@
<argument index="2" name="features" type="PoolStringArray">
</argument>
<description>
Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [code]path[/code] is the path of the file, [code]type[/code] is the [Resource] represented by the file (e.g. [PackedScene]) and [code]features[/code] is the list of features for the export.
Calling [method skip] inside this callback will make the file not included in the export.
</description>
</method>
<method name="add_file">
@ -52,6 +55,7 @@
<argument index="2" name="remap" type="bool">
</argument>
<description>
Adds a custom file to be exported. [code]path[/code] is the virtual path that can be used to load the file, [code]file[/code] is the binary data of the file. If [code]remap[/code] is [code]true[/code], file will not be exported, but instead remapped to the given [code]path[/code].
</description>
</method>
<method name="add_ios_bundle_file">
@ -60,6 +64,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Adds an iOS bundle file from the given [code]path[/code] to the exported project.
</description>
</method>
<method name="add_ios_cpp_code">
@ -68,6 +73,7 @@
<argument index="0" name="code" type="String">
</argument>
<description>
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
</description>
</method>
<method name="add_ios_embedded_framework">
@ -96,6 +102,7 @@
<argument index="0" name="flags" type="String">
</argument>
<description>
Adds linker flags for the iOS export.
</description>
</method>
<method name="add_ios_plist_content">
@ -104,6 +111,7 @@
<argument index="0" name="plist_content" type="String">
</argument>
<description>
Adds content for iOS Property List files.
</description>
</method>
<method name="add_ios_project_static_lib">
@ -112,6 +120,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Adds a static lib from the given [code]path[/code] to the iOS project.
</description>
</method>
<method name="add_shared_object">
@ -122,12 +131,14 @@
<argument index="1" name="tags" type="PoolStringArray">
</argument>
<description>
Adds a shared object with the given [code]tags[/code] and destination [code]path[/code].
</description>
</method>
<method name="skip">
<return type="void">
</return>
<description>
To be called inside [method _export_file]. Skips the current file, so it's not included in the export.
</description>
</method>
</methods>

1
doc/classes/EditorPlugin.xml
View file

@ -82,6 +82,7 @@
<argument index="0" name="plugin" type="EditorExportPlugin">
</argument>
<description>
Registers a new export plugin. Export plugins are used when the project is being exported. See [EditorExportPlugin] for more information.
</description>
</method>
<method name="add_import_plugin">