godot/doc/classes/EditorExportPlugin.xml
Sergey Minakov 1661309d59 iOS Export: Add a method to embed a framework
By default 'add_ios_framework' would not embed a framework to save previous behavior.
New 'add_ios_embedded_framework' would embed framework on export.
2020-08-19 14:35:54 +03:00

137 lines
3.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorExportPlugin" inherits="Reference" version="4.0">
<brief_description>
A script that is executed when exporting projects.
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_export_begin" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="features" type="PackedStringArray">
</argument>
<argument index="1" name="is_debug" type="bool">
</argument>
<argument index="2" name="path" type="String">
</argument>
<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.
</description>
</method>
<method name="_export_end" qualifiers="virtual">
<return type="void">
</return>
<description>
Virtual method to be overridden by the user. Called when the export is finished.
</description>
</method>
<method name="_export_file" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="type" type="String">
</argument>
<argument index="2" name="features" type="PackedStringArray">
</argument>
<description>
</description>
</method>
<method name="add_file">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="file" type="PackedByteArray">
</argument>
<argument index="2" name="remap" type="bool">
</argument>
<description>
</description>
</method>
<method name="add_ios_bundle_file">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_cpp_code">
<return type="void">
</return>
<argument index="0" name="code" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_framework">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.
</description>
</method>
<method name="add_ios_embedded_framework">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.
[b]Note:[/b] For static libraries (*.a) works in same way as [code]add_ios_framework[/code].
This method should not be used for System libraries as they are already present on the device.
</description>
</method>
<method name="add_ios_linker_flags">
<return type="void">
</return>
<argument index="0" name="flags" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_plist_content">
<return type="void">
</return>
<argument index="0" name="plist_content" type="String">
</argument>
<description>
</description>
</method>
<method name="add_ios_project_static_lib">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<description>
</description>
</method>
<method name="add_shared_object">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="tags" type="PackedStringArray">
</argument>
<description>
</description>
</method>
<method name="skip">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>