Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
EditorExportPlugin
Hereda: RefCounted < Object
Un script que se ejecuta al exportar el proyecto.
Descripción
EditorExportPlugins are automatically invoked whenever the user exports the project. They can be used to modify scenes and resources during project export based on what Feature Tags are set. For each plugin, _export_begin() is called at the beginning of the export process and then _export_file() is called for each exported file.
Register a EditorExportPlugin by creating a new EditorPlugin and calling its EditorPlugin.add_export_plugin() method.
Tutoriales
Métodos
Descripciones de Métodos
bool _begin_customize_resources(platform: EditorExportPlatform, features: PackedStringArray) virtual const 🔗
Devuelve true si este plugin personalizará los recursos basándose en la plataforma y las características usadas.
Cuando está habilitado, se llamará a _get_customization_configuration_hash() y _customize_resource() y deben ser implementados.
bool _begin_customize_scenes(platform: EditorExportPlatform, features: PackedStringArray) virtual const 🔗
Devuelve true si este plugin personalizará las escenas basándose en la plataforma y las características usadas.
Cuando está habilitado, se llamará a _get_customization_configuration_hash() y _customize_scene() y deben ser implementados.
Nota: Se llamará a _customize_scene() solo para las escenas que han sido modificadas desde la última exportación.
Resource _customize_resource(resource: Resource, path: String) virtual required 🔗
Personaliza un recurso. Si se le hacen cambios, devuelve el mismo o un nuevo recurso. De lo contrario, devuelve null. Cuando se devuelve un nuevo recurso, resource será reemplazado por una copia del nuevo recurso.
El argumento path solo se usa al personalizar un archivo real, de lo contrario esto significa que este recurso es parte de otro y estará vacío.
Es obligatorio implementar este método si _begin_customize_resources() devuelve true.
Nota: Al personalizar cualquiera de los siguientes tipos y devolver otro recurso, el otro recurso no debe omitirse usando skip() en _export_file():
Node _customize_scene(scene: Node, path: String) virtual required 🔗
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.
Note: To change a variable in your scene, use the @export annotation when declaring it.
void _end_customize_resources() virtual 🔗
Se llama a esto cuando termina el proceso de personalización de los recursos.
void _end_customize_scenes() virtual 🔗
Se llama a esto cuando termina el proceso de personalización de las escenas.
void _end_generate_apple_embedded_project(path: String, will_build_archive: bool) virtual 🔗
This is called after Xcode project generation, but before it is built.
Note: Only supported on iOS and visionOS.
void _export_begin(features: PackedStringArray, is_debug: bool, path: String, flags: int) virtual 🔗
Método virtual para ser redefinido por el usuario. Se llama cuando comienza la exportación y proporciona toda la información sobre la exportación. features es la lista de características para la exportación, is_debug es true para las compilaciones de depuración, path es la ruta de destino para el proyecto exportado. flags solo se usa cuando se ejecuta un perfil ejecutable, por ejemplo, cuando se usa la ejecución nativa en Android.
void _export_end() virtual 🔗
Método virtual que debe ser sobrescrito por el usuario. Llamado cuando la exportación esté terminada.
void _export_file(path: String, type: String, features: PackedStringArray) virtual 🔗
Método virtual que debe ser sobrescrito por el usuario. Se llama para cada archivo exportado antes de _customize_resource() y _customize_scene(). Los argumentos se pueden usar para identificar el archivo. path es la ruta del archivo, type es el Resource representado por el archivo (por ejemplo, PackedScene), y features es la lista de características para la exportación.
Llamar a skip() dentro de esta función de retorno de llamada hará que el archivo no se incluya en la exportación.
PackedStringArray _get_android_dependencies(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se llama para obtener el conjunto de dependencias de Android proporcionadas por este plugin. Cada dependencia de Android devuelta debe tener el formato de una dependencia binaria remota de Android: org.godot.example:my-plugin:0.0.0
Para más información, véase la documentación de Android sobre dependencias.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
PackedStringArray _get_android_dependencies_maven_repos(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se llama para obtener las URLs de los repositorios Maven para el conjunto de dependencias de Android proporcionadas por este plugin.
Para más información, véase la documentación de Gradle sobre gestión de dependencias.
Nota: El repositorio Maven de Google y el repositorio Maven Central ya están incluidos por defecto.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
PackedStringArray _get_android_libraries(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se llama para obtener las rutas locales de los archivos de archivo de bibliotecas de Android (AAR) proporcionados por este plugin.
Nota: Las rutas relativas deben ser relativas al directorio res://addons/ de Godot. Por ejemplo, un archivo AAR ubicado en res://addons/hello_world_plugin/HelloWorld.release.aar se puede devolver como una ruta absoluta usando res://addons/hello_world_plugin/HelloWorld.release.aar o una ruta relativa usando hello_world_plugin/HelloWorld.release.aar.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
String _get_android_manifest_activity_element_contents(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se utiliza en tiempo de exportación para actualizar el contenido del elemento activity en el manifiesto de Android generado.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
String _get_android_manifest_application_element_contents(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se utiliza en tiempo de exportación para actualizar el contenido del elemento application en el manifiesto de Android generado.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
String _get_android_manifest_element_contents(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Método virtual a ser sobrescrito por el usuario. Se utiliza en tiempo de exportación para actualizar el contenido del elemento manifest en el manifiesto de Android generado.
Nota: Solo es compatible con Android y requiere que EditorExportPlatformAndroid.gradle_build/use_gradle_build esté habilitado.
int _get_customization_configuration_hash() virtual required const 🔗
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 _begin_customize_resources() returns true.
Note: _customize_resource() and _customize_scene() will not be called when the EditorExportPlugin script is modified unless this hash changes too.
PackedStringArray _get_export_features(platform: EditorExportPlatform, debug: bool) virtual const 🔗
Devuelve un PackedStringArray de características adicionales que este ajuste preestablecido, para la platform dada, debería tener.
bool _get_export_option_visibility(platform: EditorExportPlatform, option: String) virtual const 🔗
Valida option y devuelve la visibilidad para la platform especificada. La implementación predeterminada devuelve true para todas las opciones.
String _get_export_option_warning(platform: EditorExportPlatform, option: String) virtual const 🔗
Verifica los requisitos para la option dada y devuelve una string de advertencia no vacía si no se cumplen.
Nota: Utiliza get_option() para verificar el valor de las opciones de exportación.
Array[Dictionary] _get_export_options(platform: EditorExportPlatform) virtual const 🔗
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 Object.get_property_list(), but all keys are optional.default_value: The default value for this option.update_visibility: An optional boolean value. If set totrue, the preset will emit Object.property_list_changed when the option is changed.
Dictionary _get_export_options_overrides(platform: EditorExportPlatform) virtual const 🔗
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,
}
String _get_name() virtual required const 🔗
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.
bool _should_update_export_options(platform: EditorExportPlatform) virtual const 🔗
Return true if the result of _get_export_options() has changed and the export options of the preset corresponding to platform should be updated.
bool _supports_platform(platform: EditorExportPlatform) virtual const 🔗
Return true if the plugin supports the given platform.
PackedByteArray _update_android_prebuilt_manifest(platform: EditorExportPlatform, manifest_data: PackedByteArray) virtual const 🔗
Provide access to the Android prebuilt manifest and allows the plugin to modify it if needed.
Implementers of this virtual method should take the binary manifest data from manifest_data, copy it, modify it, and then return it with the modifications.
If no modifications are needed, then an empty PackedByteArray should be returned.
void add_apple_embedded_platform_bundle_file(path: String) 🔗
Adds an Apple embedded platform bundle file from the given path to the exported project.
void add_apple_embedded_platform_cpp_code(code: String) 🔗
Adds C++ code to the Apple embedded platform export. The final code is created from the code appended by each active export plugin.
void add_apple_embedded_platform_embedded_framework(path: String) 🔗
Adds a dynamic library (*.dylib, *.framework) to the Linking Phase in the Apple embedded platform's Xcode project and embeds it into the resulting binary.
Note: For static libraries (*.a), this works in the same way as add_apple_embedded_platform_framework().
Note: This method should not be used for System libraries as they are already present on the device.
void add_apple_embedded_platform_framework(path: String) 🔗
Adds a static library (*.a) or a dynamic library (*.dylib, *.framework) to the Linking Phase to the Apple embedded platform's Xcode project.
void add_apple_embedded_platform_linker_flags(flags: String) 🔗
Adds linker flags for the Apple embedded platform export.
void add_apple_embedded_platform_plist_content(plist_content: String) 🔗
Adds additional fields to the Apple embedded platform's project Info.plist file.
void add_apple_embedded_platform_project_static_lib(path: String) 🔗
Adds a static library from the given path to the Apple embedded platform project.
void add_file(path: String, file: PackedByteArray, remap: 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 _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 _customize_resource() to remap imported resources.
void add_ios_bundle_file(path: String) 🔗
Obsoleto: Use add_apple_embedded_platform_bundle_file() instead.
Adds an iOS bundle file from the given path to the exported project.
void add_ios_cpp_code(code: String) 🔗
Obsoleto: Use add_apple_embedded_platform_cpp_code() instead.
Adds 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(path: String) 🔗
Obsoleto: Use add_apple_embedded_platform_embedded_framework() instead.
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), this works the in same way as add_apple_embedded_platform_framework().
Note: This method should not be used for System libraries as they are already present on the device.
void add_ios_framework(path: String) 🔗
Obsoleto: Use add_apple_embedded_platform_framework() instead.
Adds a static library (*.a) or a dynamic library (*.dylib, *.framework) to the Linking Phase to the iOS Xcode project.
void add_ios_linker_flags(flags: String) 🔗
Obsoleto: Use add_apple_embedded_platform_linker_flags() instead.
Adds linker flags for the iOS export.
void add_ios_plist_content(plist_content: String) 🔗
Obsoleto: Use add_apple_embedded_platform_plist_content() instead.
Adds additional fields to the iOS project Info.plist file.
void add_ios_project_static_lib(path: String) 🔗
Obsoleto: Use add_apple_embedded_platform_project_static_lib() instead.
Adds a static library from the given path to the iOS project.
void add_macos_plugin_file(path: String) 🔗
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.
EditorExportPlatform get_export_platform() const 🔗
Devuelve la plataforma de exportación utilizada actualmente.
EditorExportPreset get_export_preset() const 🔗
Devuelve el ajuste preestablecido de exportación utilizado actualmente.
Variant get_option(name: StringName) const 🔗
Returns the current value of an export option supplied by _get_export_options().
void skip() 🔗
To be called inside _export_file(). Skips the current file, so it's not included in the export.