2017-09-16 01:46:14 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 10:08:05 +02:00
<class name= "EditorExportPlugin" inherits= "RefCounted" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-16 01:46:14 +02:00
<brief_description >
2020-12-29 12:23:29 +01:00
A script that is executed when exporting the project.
2017-09-16 01:46:14 +02:00
</brief_description>
<description >
2021-10-15 14:30:58 +02:00
[EditorExportPlugin]s are automatically invoked 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.
To use [EditorExportPlugin], register it using the [method EditorPlugin.add_export_plugin] method first.
2017-09-16 01:46:14 +02:00
</description>
<tutorials >
</tutorials>
<methods >
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
<method name= "_begin_customize_resources" qualifiers= "virtual const" >
<return type= "bool" />
<param index= "0" name= "platform" type= "EditorExportPlatform" />
<param index= "1" name= "features" type= "PackedStringArray" />
<description >
2023-02-27 11:54:01 +01:00
Return [code]true[/code] if this plugin will customize resources based on the platform and features used.
When enabled, [method _get_customization_configuration_hash], [method _customize_resource] and [method _customize_scene] will be called and must be implemented.
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
</description>
</method>
<method name= "_begin_customize_scenes" qualifiers= "virtual const" >
<return type= "bool" />
<param index= "0" name= "platform" type= "EditorExportPlatform" />
<param index= "1" name= "features" type= "PackedStringArray" />
<description >
Return true if this plugin will customize scenes based on the platform and features used.
</description>
</method>
<method name= "_customize_resource" qualifiers= "virtual" >
<return type= "Resource" />
<param index= "0" name= "resource" type= "Resource" />
<param index= "1" name= "path" type= "String" />
<description >
Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return [code]null[/code].
The [i]path[/i] argument is only used when customizing an actual file, otherwise this means that this resource is part of another one and it will be empty.
2023-02-27 11:54:01 +01:00
Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
</description>
</method>
<method name= "_customize_scene" qualifiers= "virtual" >
<return type= "Node" />
<param index= "0" name= "scene" type= "Node" />
<param index= "1" name= "path" type= "String" />
<description >
Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return [code]null[/code]. If a new scene is returned, it is up to you to dispose of the old one.
2023-02-27 11:54:01 +01:00
Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
</description>
</method>
<method name= "_end_customize_resources" qualifiers= "virtual" >
<return type= "void" />
<description >
This is called when the customization process for resources ends.
</description>
</method>
<method name= "_end_customize_scenes" qualifiers= "virtual" >
<return type= "void" />
<description >
This is called when the customization process for scenes ends.
</description>
</method>
2017-09-16 01:46:14 +02:00
<method name= "_export_begin" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "features" type= "PackedStringArray" />
<param index= "1" name= "is_debug" type= "bool" />
<param index= "2" name= "path" type= "String" />
<param index= "3" name= "flags" type= "int" />
2017-09-16 01:46:14 +02:00
<description >
2022-08-12 18:07:53 +02:00
Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. [param features] is the list of features for the export, [param is_debug] is [code]true[/code] for debug builds, [param path] is the target path for the exported project. [param flags] is only used when running a runnable profile, e.g. when using native run on Android.
2019-05-23 23:31:02 +02:00
</description>
</method>
<method name= "_export_end" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2019-05-23 23:31:02 +02:00
<description >
2020-03-03 19:21:21 +01:00
Virtual method to be overridden by the user. Called when the export is finished.
2017-09-16 01:46:14 +02:00
</description>
</method>
<method name= "_export_file" qualifiers= "virtual" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
<param index= "1" name= "type" type= "String" />
<param index= "2" name= "features" type= "PackedStringArray" />
2017-09-16 01:46:14 +02:00
<description >
2022-08-12 18:07:53 +02:00
Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. [param path] is the path of the file, [param type] is the [Resource] represented by the file (e.g. [PackedScene]) and [param features] is the list of features for the export.
2020-12-29 12:23:29 +01:00
Calling [method skip] inside this callback will make the file not included in the export.
2017-09-16 01:46:14 +02:00
</description>
</method>
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
<method name= "_get_customization_configuration_hash" qualifiers= "virtual const" >
<return type= "int" />
<description >
Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.
2023-02-27 11:54:01 +01:00
Implementing this method is required if [method _begin_customize_resources] returns [code]true[/code].
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
</description>
</method>
2023-02-07 22:33:19 +01:00
<method name= "_get_export_features" qualifiers= "virtual const" >
<return type= "PackedStringArray" />
<param index= "0" name= "platform" type= "EditorExportPlatform" />
<param index= "1" name= "debug" type= "bool" />
<description >
Return a [PackedStringArray] of additional features this preset, for the given [param platform], should have.
</description>
</method>
2023-02-08 13:36:02 +01:00
<method name= "_get_export_options" qualifiers= "virtual const" >
<return type= "Dictionary[]" />
<param index= "0" name= "platform" type= "EditorExportPlatform" />
<description >
Return a list of export options that can be configured for this export plugin.
Each element in the return value is a [Dictionary] with the following keys:
- [code]option[/code]: A dictionary with the structure documented by [method Object.get_property_list], but all keys are optional.
- [code]default_value[/code]: The default value for this option.
- [code]update_visibility[/code]: An optional boolean value. If set to [code]true[/code], the preset will emit [signal Object.property_list_changed] when the option is changed.
</description>
</method>
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
<method name= "_get_name" qualifiers= "virtual const" >
<return type= "String" />
<description >
2023-02-27 11:54:01 +01:00
Return the name identifier of this plugin (for future identification by the exporter). The plugins are sorted by name before exporting.
Implementing this method is required.
Add support for scene/resource customization in export plugins
EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported:
* Can take scene files, resource files and subresources in all of them.
* Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified.
* Uses hashing to differentiate export configuration caches.
* Removed the previous conversion code to binary, as this one uses existing stuff.
This API is useful in several scenarios:
* Needed by the "server" export platform to get rid of textures, meshes, audio, etc.
* Needed by text to binary converters.
* Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc.
This is a draft, feedback is very welcome.
2022-08-31 11:12:42 +02:00
</description>
</method>
2023-02-08 13:36:02 +01:00
<method name= "_should_update_export_options" qualifiers= "virtual const" >
<return type= "bool" />
<param index= "0" name= "platform" type= "EditorExportPlatform" />
<description >
Return [code]true[/code], if the result of [method _get_export_options] has changed and the export options of preset corresponding to [param platform] should be updated.
</description>
</method>
2017-09-16 01:46:14 +02:00
<method name= "add_file" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
<param index= "1" name= "file" type= "PackedByteArray" />
<param index= "2" name= "remap" type= "bool" />
2017-09-16 01:46:14 +02:00
<description >
2023-07-11 03:07:22 +02:00
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.
2017-09-16 01:46:14 +02:00
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "add_ios_bundle_file" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
2017-11-24 09:16:27 +01:00
<description >
2022-08-12 18:07:53 +02:00
Adds an iOS bundle file from the given [param path] to the exported project.
2017-11-24 09:16:27 +01:00
</description>
</method>
<method name= "add_ios_cpp_code" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "code" type= "String" />
2017-11-24 09:16:27 +01:00
<description >
2020-12-29 12:23:29 +01:00
Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.
2017-11-24 09:16:27 +01:00
</description>
</method>
2020-08-31 11:25:11 +02:00
<method name= "add_ios_embedded_framework" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
2017-11-24 09:16:27 +01:00
<description >
2020-08-31 11:25:11 +02:00
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.
2020-08-05 19:55:29 +02:00
</description>
</method>
2020-08-31 11:25:11 +02:00
<method name= "add_ios_framework" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
2020-08-05 19:55:29 +02:00
<description >
2020-08-31 11:25:11 +02:00
Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.
2017-11-24 09:16:27 +01:00
</description>
</method>
<method name= "add_ios_linker_flags" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "flags" type= "String" />
2017-11-24 09:16:27 +01:00
<description >
2020-12-29 12:23:29 +01:00
Adds linker flags for the iOS export.
2017-11-24 09:16:27 +01:00
</description>
</method>
<method name= "add_ios_plist_content" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "plist_content" type= "String" />
2017-11-24 09:16:27 +01:00
<description >
2020-12-29 12:23:29 +01:00
Adds content for iOS Property List files.
2017-11-24 09:16:27 +01:00
</description>
</method>
2020-04-03 10:11:23 +02:00
<method name= "add_ios_project_static_lib" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
2020-04-03 10:11:23 +02:00
<description >
2022-08-12 18:07:53 +02:00
Adds a static lib from the given [param path] to the iOS project.
2020-04-03 10:11:23 +02:00
</description>
</method>
2022-07-20 08:28:22 +02:00
<method name= "add_macos_plugin_file" >
2021-12-18 10:21:08 +01:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
2021-12-18 10:21:08 +01:00
<description >
2022-08-12 18:07:53 +02:00
Adds file or directory matching [param path] to [code]PlugIns[/code] directory of macOS app bundle.
2021-12-18 10:21:08 +01:00
[b]Note:[/b] This is useful only for macOS exports.
</description>
</method>
2017-09-16 01:46:14 +02:00
<method name= "add_shared_object" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2022-08-06 20:11:48 +02:00
<param index= "0" name= "path" type= "String" />
<param index= "1" name= "tags" type= "PackedStringArray" />
<param index= "2" name= "target" type= "String" />
2017-09-16 01:46:14 +02:00
<description >
2022-08-12 18:07:53 +02:00
Adds a shared object or a directory containing only shared objects with the given [param tags] and destination [param path].
2021-12-18 10:21:08 +01:00
[b]Note:[/b] In case of macOS exports, those shared objects will be added to [code]Frameworks[/code] directory of app bundle.
In case of a directory code-sign will error if you place non code object in directory.
2017-09-16 01:46:14 +02:00
</description>
</method>
2023-02-08 13:36:02 +01:00
<method name= "get_option" qualifiers= "const" >
<return type= "Variant" />
<param index= "0" name= "name" type= "StringName" />
<description >
Returns the current value of an export option supplied by [method _get_export_options].
</description>
</method>
2017-09-16 01:46:14 +02:00
<method name= "skip" >
2021-07-30 15:28:05 +02:00
<return type= "void" />
2017-09-16 01:46:14 +02:00
<description >
2020-12-29 12:23:29 +01:00
To be called inside [method _export_file]. Skips the current file, so it's not included in the export.
2017-09-16 01:46:14 +02:00
</description>
</method>
</methods>
</class>
