EditorExportPlugin

Inherits: RefCounted < Object

A script that is executed when exporting the project.

Description

EditorExportPlugins 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, _export_begin is called at the beginning of the export process and then _export_file is called for each exported file.

To use EditorExportPlugin, register it using the EditorPlugin.add_export_plugin method first.

Methods

bool

_begin_customize_resources ( EditorExportPlatform platform, PackedStringArray features ) virtual const

bool

_begin_customize_scenes ( EditorExportPlatform platform, PackedStringArray features ) virtual const

Resource

_customize_resource ( Resource resource, String path ) virtual

Node

_customize_scene ( Node scene, String path ) virtual

void

_end_customize_resources ( ) virtual

void

_end_customize_scenes ( ) virtual

void

_export_begin ( PackedStringArray features, bool is_debug, String path, int flags ) virtual

void

_export_end ( ) virtual

void

_export_file ( String path, String type, PackedStringArray features ) virtual

int

_get_customization_configuration_hash ( ) virtual const

String

_get_name ( ) virtual const

void

add_file ( String path, PackedByteArray file, bool remap )

void

add_ios_bundle_file ( String path )

void

add_ios_cpp_code ( String code )

void

add_ios_embedded_framework ( String path )

void

add_ios_framework ( String path )

void

add_ios_linker_flags ( String flags )

void

add_ios_plist_content ( String plist_content )

void

add_ios_project_static_lib ( String path )

void

add_macos_plugin_file ( String path )

void

add_shared_object ( String path, PackedStringArray tags, String target )

void

skip ( )

Method Descriptions

Return true if this plugin will customize resources based on the platform and features used.


Return true if this plugin will customize scenes based on the platform and features used.


Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return null.

The path 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.


Customize a scene. If changes are made to it, return the same or a new scene. Otherwise, return null. If a new scene is returned, it is up to you to dispose of the old one.


  • void _end_customize_resources ( ) virtual

This is called when the customization process for resources ends.


  • void _end_customize_scenes ( ) virtual

This is called when the customization process for scenes ends.


Virtual method to be overridden by the user. It is called when the export starts and provides all information about the export. features is the list of features for the export, is_debug is true for debug builds, path is the target path for the exported project. flags is only used when running a runnable profile, e.g. when using native run on Android.


  • void _export_end ( ) virtual

Virtual method to be overridden by the user. Called when the export is finished.


Virtual method to be overridden by the user. Called for each exported file, providing arguments that can be used to identify the file. path is the path of the file, type is the Resource represented by the file (e.g. PackedScene) and features is the list of features for the export.

Calling skip inside this callback will make the file not included in the export.


  • int _get_customization_configuration_hash ( ) virtual const

Return a hash based on the configuration passed (for both scenes and resources). This helps keep separate caches for separate export configurations.


  • String _get_name ( ) virtual const

Return the name identifier of this plugin (for future identification by the exporter).


Adds a custom file to be exported. path is the virtual path that can be used to load the file, file is the binary data of the file. If remap is true, file will not be exported, but instead remapped to the given path.


  • void add_ios_bundle_file ( String path )

Adds an iOS bundle file from the given path to the exported project.


  • void add_ios_cpp_code ( String code )

Adds a C++ code to the iOS export. The final code is created from the code appended by each active export plugin.


  • void add_ios_embedded_framework ( String path )

Adds a dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project and embeds it into resulting binary.

Note: For static libraries (*.a) works in same way as add_ios_framework.

This method should not be used for System libraries as they are already present on the device.


  • void add_ios_framework ( String path )

Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project.


  • void add_ios_linker_flags ( String flags )

Adds linker flags for the iOS export.


  • void add_ios_plist_content ( String plist_content )

Adds content for iOS Property List files.


  • void add_ios_project_static_lib ( String path )

Adds a static lib from the given path to the iOS project.


  • void add_macos_plugin_file ( String path )

Adds file or directory matching path to PlugIns directory of macOS app bundle.

Note: This is useful only for macOS exports.


Adds a shared object or a directory containing only shared objects with the given tags and destination path.

Note: In case of macOS exports, those shared objects will be added to Frameworks directory of app bundle.

In case of a directory code-sign will error if you place non code object in directory.


  • void skip ( )

To be called inside _export_file. Skips the current file, so it's not included in the export.