Class EditorExportPlugin

A script that is executed when exporting the project.

Inheritance: RefCounted

Object

EditorExportPlugin

Remarks

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

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

Methods

_begin_customize_resources(EditorExportPlatform, PackedStringArray)

Qualifiers: virtualconst

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

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

bool _begin_customize_resources(EditorExportPlatform platform, PackedStringArray features)

Parameters

platform EditorExportPlatform
features PackedStringArray

_begin_customize_scenes(EditorExportPlatform, PackedStringArray)

Qualifiers: virtualconst

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

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

Note: EditorExportPlugin._customize_scene will only be called for scenes that have been modified since the last export.

bool _begin_customize_scenes(EditorExportPlatform platform, PackedStringArray features)

Parameters

platform EditorExportPlatform
features PackedStringArray

_customize_resource(Resource, String)

Qualifiers: virtual

Customize a resource. If changes are made to it, return the same or a new resource. Otherwise, return null. When a new resource is returned, resource will be replaced by a copy of the new resource.

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 EditorExportPlugin._begin_customize_resources returns true.

Note: When customizing any of the following types and returning another resource, the other resource should not be skipped using skip in EditorExportPlugin._export_file:

Resource _customize_resource(Resource resource, String path)

Parameters

resource Resource
path String

_customize_scene(Node, String)

Qualifiers: 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 EditorExportPlugin._begin_customize_scenes returns true.

Node _customize_scene(Node scene, String path)

Parameters

scene Node
path String

_end_customize_resources

Qualifiers: virtual

This is called when the customization process for resources ends.

void _end_customize_resources

_end_customize_scenes

Qualifiers: virtual

This is called when the customization process for scenes ends.

void _end_customize_scenes

_export_begin(PackedStringArray, bool, String, int)

Qualifiers: 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_begin(PackedStringArray features, bool is_debug, String path, int flags)

Parameters

features PackedStringArray
is_debug bool
path String
flags int

_export_end

Qualifiers: virtual

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

void _export_end

_export_file(String, String, PackedStringArray)

Qualifiers: virtual

Virtual method to be overridden by the user. Called for each exported file before EditorExportPlugin._customize_resource and EditorExportPlugin._customize_scene. The arguments 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.

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

Parameters

path String
type String
features PackedStringArray

_get_android_dependencies(EditorExportPlatform, bool)

Qualifiers: virtualconst

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 gradle_build/use_gradle_build to be enabled.

PackedStringArray _get_android_dependencies(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_android_dependencies_maven_repos(EditorExportPlatform, bool)

Qualifiers: virtualconst

Virtual method to be overridden by the user. This is called to retrieve the URLs of Maven repositories for the set of Android dependencies provided by this plugin.

For more information see Gradle documentation on dependency management.

Note: Google's Maven repo and the Maven Central repo are already included by default.

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

PackedStringArray _get_android_dependencies_maven_repos(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_android_libraries(EditorExportPlatform, bool)

Qualifiers: virtualconst

Virtual method to be overridden by the user. This is called to retrieve the local paths of the Android libraries archive (AAR) files provided by this plugin.

Note: Relative paths must be relative to Godot's res://addons/ directory. For example, an AAR file located under res://addons/hello_world_plugin/HelloWorld.release.aar can be returned as an absolute path using res://addons/hello_world_plugin/HelloWorld.release.aar or a relative path using hello_world_plugin/HelloWorld.release.aar.

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

PackedStringArray _get_android_libraries(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_android_manifest_activity_element_contents(EditorExportPlatform, bool)

Qualifiers: virtualconst

Virtual method to be overridden by the user. This is used at export time to update the contents of the activity element in the generated Android manifest.

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

String _get_android_manifest_activity_element_contents(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_android_manifest_application_element_contents(EditorExportPlatform, bool)

Qualifiers: virtualconst

Virtual method to be overridden by the user. This is used at export time to update the contents of the application element in the generated Android manifest.

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

String _get_android_manifest_application_element_contents(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_android_manifest_element_contents(EditorExportPlatform, bool)

Qualifiers: virtualconst

Virtual method to be overridden by the user. This is used at export time to update the contents of the manifest element in the generated Android manifest.

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

String _get_android_manifest_element_contents(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_customization_configuration_hash

Qualifiers: virtualconst

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

Implementing this method is required if EditorExportPlugin._begin_customize_resources returns true.

int _get_customization_configuration_hash

_get_export_features(EditorExportPlatform, bool)

Qualifiers: virtualconst

Return a PackedStringArray of additional features this preset, for the given platform, should have.

PackedStringArray _get_export_features(EditorExportPlatform platform, bool debug)

Parameters

platform EditorExportPlatform
debug bool

_get_export_option_visibility(EditorExportPlatform, String)

Qualifiers: virtualconst

Optional.

Validates option and returns the visibility for the specified platform. The default implementation returns true for all options.

bool _get_export_option_visibility(EditorExportPlatform platform, String option)

Parameters

platform EditorExportPlatform
option String

_get_export_option_warning(EditorExportPlatform, String)

Qualifiers: virtualconst

Check the requirements for the given option and return a non-empty warning string if they are not met.

Note: Use EditorExportPlugin.get_option to check the value of the export options.

String _get_export_option_warning(EditorExportPlatform platform, String option)

Parameters

platform EditorExportPlatform
option String

_get_export_options(EditorExportPlatform)

Qualifiers: virtualconst

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:

option: A dictionary with the structure documented by get_property_list, but all keys are optional.
default_value: The default value for this option.
update_visibility: An optional boolean value. If set to true, the preset will emit property_list_changed when the option is changed.

Dictionary[] _get_export_options(EditorExportPlatform platform)

Parameters

platform EditorExportPlatform

_get_export_options_overrides(EditorExportPlatform)

Qualifiers: virtualconst

Return a Dictionary of override values for export options, that will be used instead of user-provided values. Overridden options will be hidden from the user interface.

class MyExportPlugin extends EditorExportPlugin:
    func _get_name() -> String:
        return "MyExportPlugin"

    func _supports_platform(platform) -> bool:
        if platform is EditorExportPlatformPC:
            # Run on all desktop platforms including Windows, MacOS and Linux.
            return true
        return false

    func _get_export_options_overrides(platform) -> Dictionary:
        # Override "Embed PCK" to always be enabled.
        return {
            "binary_format/embed_pck": true,

        }

Dictionary _get_export_options_overrides(EditorExportPlatform platform)

Parameters

platform EditorExportPlatform

_get_name

Qualifiers: virtualconst

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.

String _get_name

_should_update_export_options(EditorExportPlatform)

Qualifiers: virtualconst

Return true, if the result of EditorExportPlugin._get_export_options has changed and the export options of preset corresponding to platform should be updated.

bool _should_update_export_options(EditorExportPlatform platform)

Parameters

platform EditorExportPlatform

_supports_platform(EditorExportPlatform)

Qualifiers: virtualconst

Return true if the plugin supports the given platform.

bool _supports_platform(EditorExportPlatform platform)

Parameters

platform EditorExportPlatform

add_file(String, PackedByteArray, bool)

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.

When called inside EditorExportPlugin._export_file and remap is true, the current file will not be exported, but instead remapped to this custom file. remap is ignored when called in other places.

file will not be imported, so consider using EditorExportPlugin._customize_resource to remap imported resources.

void add_file(String path, PackedByteArray file, bool remap)

Parameters

path String
file PackedByteArray
remap bool

add_ios_bundle_file(String)

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

void add_ios_bundle_file(String path)

Parameters

path String

add_ios_cpp_code(String)

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_cpp_code(String code)

Parameters

code String

add_ios_embedded_framework(String)

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 EditorExportPlugin.add_ios_framework.

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

void add_ios_embedded_framework(String path)

Parameters

path String

add_ios_framework(String)

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

void add_ios_framework(String path)

Parameters

path String

add_ios_linker_flags(String)

Adds linker flags for the iOS export.

void add_ios_linker_flags(String flags)

Parameters

flags String

add_ios_plist_content(String)

Adds content for iOS Property List files.

void add_ios_plist_content(String plist_content)

Parameters

plist_content String

add_ios_project_static_lib(String)

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

void add_ios_project_static_lib(String path)

Parameters

path String

add_macos_plugin_file(String)

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

Note: This is useful only for macOS exports.

void add_macos_plugin_file(String path)

Parameters

path String

add_shared_object(String, PackedStringArray, String)

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 add_shared_object(String path, PackedStringArray tags, String target)

Parameters

path String
tags PackedStringArray
target String

get_export_platform

Qualifiers: const

Returns currently used export platform.

EditorExportPlatform get_export_platform

get_export_preset

Qualifiers: const

Returns currently used export preset.

EditorExportPreset get_export_preset

get_option(StringName)

Qualifiers: const

Returns the current value of an export option supplied by EditorExportPlugin._get_export_options.

Variant get_option(StringName name)

Parameters

name StringName

skip

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

void skip

Table of Contents

Class EditorExportPlugin

Remarks

See Also

Methods

_begin_customize_resources(EditorExportPlatform, PackedStringArray)

Parameters

_begin_customize_scenes(EditorExportPlatform, PackedStringArray)

Parameters

_customize_resource(Resource, String)

Parameters

_customize_scene(Node, String)

Parameters

_end_customize_resources

_end_customize_scenes

_export_begin(PackedStringArray, bool, String, int)

Parameters

_export_end

_export_file(String, String, PackedStringArray)

Parameters

_get_android_dependencies(EditorExportPlatform, bool)

Parameters

_get_android_dependencies_maven_repos(EditorExportPlatform, bool)

Parameters

_get_android_libraries(EditorExportPlatform, bool)

Parameters

_get_android_manifest_activity_element_contents(EditorExportPlatform, bool)

Parameters

_get_android_manifest_application_element_contents(EditorExportPlatform, bool)

Parameters

_get_android_manifest_element_contents(EditorExportPlatform, bool)

Parameters

_get_customization_configuration_hash

_get_export_features(EditorExportPlatform, bool)

Parameters

_get_export_option_visibility(EditorExportPlatform, String)

Parameters

_get_export_option_warning(EditorExportPlatform, String)

Parameters

_get_export_options(EditorExportPlatform)

Parameters

_get_export_options_overrides(EditorExportPlatform)

Parameters

_get_name

_should_update_export_options(EditorExportPlatform)

Parameters

_supports_platform(EditorExportPlatform)

Parameters

add_file(String, PackedByteArray, bool)

Parameters

add_ios_bundle_file(String)

Parameters

add_ios_cpp_code(String)

Parameters

add_ios_embedded_framework(String)

Parameters

add_ios_framework(String)

Parameters

add_ios_linker_flags(String)

Parameters

add_ios_plist_content(String)

Parameters

add_ios_project_static_lib(String)

Parameters

add_macos_plugin_file(String)

Parameters

add_shared_object(String, PackedStringArray, String)

Parameters

get_export_platform

get_export_preset

get_option(StringName)

Parameters

skip