Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

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.

Tutorials

• Export Android plugins

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
PackedStringArray	_get_android_dependencies ( EditorExportPlatform platform, bool debug ) virtual const
PackedStringArray	_get_android_dependencies_maven_repos ( EditorExportPlatform platform, bool debug ) virtual const
PackedStringArray	_get_android_libraries ( EditorExportPlatform platform, bool debug ) virtual const
String	_get_android_manifest_activity_element_contents ( EditorExportPlatform platform, bool debug ) virtual const
String	_get_android_manifest_application_element_contents ( EditorExportPlatform platform, bool debug ) virtual const
String	_get_android_manifest_element_contents ( EditorExportPlatform platform, bool debug ) virtual const
int	_get_customization_configuration_hash ( ) virtual const
PackedStringArray	_get_export_features ( EditorExportPlatform platform, bool debug ) virtual const
String	_get_export_option_warning ( EditorExportPlatform platform, String option ) virtual const
Dictionary[]	_get_export_options ( EditorExportPlatform platform ) virtual const
String	_get_name ( ) virtual const
bool	_should_update_export_options ( EditorExportPlatform platform ) virtual const
bool	_supports_platform ( EditorExportPlatform platform ) 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 )
Variant	get_option ( StringName name ) const
void	skip ( )

---

Method Descriptions

bool _begin_customize_resources ( EditorExportPlatform platform, PackedStringArray features ) virtual const

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

When enabled, _get_customization_configuration_hash, _customize_resource and _customize_scene will be called and must be implemented.

---

bool _begin_customize_scenes ( EditorExportPlatform platform, PackedStringArray features ) virtual const

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

---

Resource _customize_resource ( Resource resource, String path ) virtual

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.

Implementing this method is required if _begin_customize_resources returns true.

---

Node _customize_scene ( Node scene, String path ) virtual

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.

Implementing this method is required if _begin_customize_scenes returns true.

---

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.

---

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

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.

---

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

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.

---

PackedStringArray _get_android_dependencies ( EditorExportPlatform platform, bool debug ) virtual const

Virtual method to be overridden by the user. This is called to retrieve the set of Android dependencies provided by this plugin. Each returned Android dependency should have the format of an Android remote binary dependency: org.godot.example:my-plugin:0.0.0

For more information see Android documentation on dependencies.

Note: Only supported on Android and requires EditorExportPlatformAndroid.gradle_build/use_gradle_build to be enabled.

---

PackedStringArray _get_android_dependencies_maven_repos ( EditorExportPlatform platform,