EditorExportPlatformExtension
Hereda: EditorExportPlatform < RefCounted < Object
Clase base para implementaciones personalizadas de EditorExportPlatform (plugins).
Descripción
Las implementaciones externas de EditorExportPlatform deben heredar de esta clase.
Para usar EditorExportPlatform, regístralo primero usando el método EditorPlugin.add_export_platform().
Métodos
Descripciones de Métodos
bool _can_export(preset: EditorExportPreset, debug: bool) virtual const 🔗
Devuelve true, si el preset especificado es válido y se puede exportar. Usa set_config_error() y set_config_missing_templates() para establecer los detalles del error.
La implementación habitual puede llamar a _has_valid_export_configuration() y _has_valid_project_configuration() para determinar si la exportación es posible.
void _cleanup() virtual 🔗
Llamado por el editor antes de que se desregistre la plataforma.
Error _export_pack(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivo PCK en path para el preset especificado.
Este método se llama cuando se presiona el botón "Export PCK/ZIP" en el diálogo de exportación, con "Export as Patch" desactivado, y PCK se selecciona como tipo de archivo.
Error _export_pack_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivo PCK de parche en path para el preset especificado, que contiene solo los archivos que han cambiado desde el último parche.
Este método se llama cuando se presiona el botón "Export PCK/ZIP" en el diálogo de exportación, con "Export as Patch" habilitado, y PCK se selecciona como tipo de archivo.
Nota: Los parches proporcionados en patches ya se han cargado cuando se llama a este método y simplemente se proporcionan como contexto. Cuando esté vacío, se cargarán los parches definidos en el preset de exportación.
Error _export_project(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual required 🔗
Crea un proyecto completo en path para el preset especificado.
Este método se llama cuando se presiona el botón "Exportar" en el diálogo de exportación.
Esta implementación del método puede llamar a EditorExportPlatform.save_pack() o EditorExportPlatform.save_zip() para usar el proceso de exportación PCK/ZIP predeterminado, o llama a EditorExportPlatform.export_project_files() e implementa una función de retorno personalizada para procesar cada archivo exportado.
Error _export_zip(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivo ZIP en path para el preset especificado.
Este método se llama cuando se presiona el botón "Export PCK/ZIP" en el diálogo de exportación, con "Export as Patch" desactivado, y ZIP se selecciona como tipo de archivo.
Error _export_zip_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivo ZIP en path para el preset especificado, que contiene solo los archivos que han cambiado desde el último parche.
Este método se llama cuando se presiona el botón "Export PCK/ZIP" en el diálogo de exportación, con "Export as Patch" habilitado, y ZIP se selecciona como tipo de archivo.
Nota: Los parches proporcionados en patches ya se han cargado cuando se llama a este método y simplemente se proporcionan como contexto. Cuando esté vacío, se cargarán los parches definidos en el preset de exportación.
PackedStringArray _get_binary_extensions(preset: EditorExportPreset) virtual required const 🔗
Devuelve un array de extensiones binarias compatibles para la exportación completa del proyecto.
String _get_debug_protocol() virtual const 🔗
Devuelve el protocolo utilizado para la depuración remota. La implementación predeterminada devuelve tcp://.
String _get_device_architecture(device: int) virtual const 🔗
Devuelve la arquitectura del dispositivo para una implementación con un solo clic.
bool _get_export_option_visibility(preset: EditorExportPreset, option: String) virtual const 🔗
Valida option y devuelve la visibilidad para el preset especificado. La implementación predeterminada devuelve true para todas las opciones.
String _get_export_option_warning(preset: EditorExportPreset, option: StringName) virtual const 🔗
Valida option y devuelve un mensaje de advertencia para el preset especificado. La implementación predeterminada devuelve una string vacía para todas las opciones.
Array[Dictionary] _get_export_options() virtual const 🔗
Devuelve una lista de propiedades, como un Array de diccionarios. Cada Dictionary debe contener al menos las entradas name: StringName y type: Variant.Type.
Además, se admiten las siguientes claves:
hint: PropertyHinthint_string: Stringusage: PropertyUsageFlagsclass_name: StringNamedefault_value: Variant, valor predeterminado de la propiedad.update_visibility: bool, si se establece entrue, _get_export_option_visibility() se llama para cada propiedad cuando se cambia esta propiedad.required: bool, si se establece entrue, las advertencias de esta propiedad son críticas y deben resolverse para que la exportación sea posible. Este valor es una sugerencia para la implementación de _has_valid_export_configuration() y no es utilizado directamente por el motor.
Véase también Object._get_property_list().
Texture2D _get_logo() virtual required const 🔗
Devuelve el logo de la plataforma que se muestra en el diálogo de exportación. El logo debería ser de 32×32 píxeles, ajustado a la escala actual del editor (véase EditorInterface.get_editor_scale()).
String _get_name() virtual required const 🔗
Devuelve el nombre de la plataforma de exportación.
Texture2D _get_option_icon(device: int) virtual const 🔗
Devuelve el icono del elemento para el device especificado en el menú de implementación con un solo clic. El icono debe ser de 16×16 píxeles, ajustado a la escala actual del editor (véase EditorInterface.get_editor_scale()).
String _get_option_label(device: int) virtual const 🔗
Devuelve la etiqueta del elemento del menú de implementación con un solo clic para el device especificado.
String _get_option_tooltip(device: int) virtual const 🔗
Devuelve la información sobre la herramienta del elemento del menú de implementación con un solo clic para el device especificado.
int _get_options_count() virtual const 🔗
Devuelve el número de dispositivos (u otras opciones) disponibles en el menú de implementación con un solo clic.
String _get_options_tooltip() virtual const 🔗
Devuelve la información sobre herramientas del botón del menú de implementación de un clic.
String _get_os_name() virtual required const 🔗
Devuelve el nombre del sistema operativo de destino.
PackedStringArray _get_platform_features() virtual required const 🔗
Devuelve un array de características específicas de la plataforma.
PackedStringArray _get_preset_features(preset: EditorExportPreset) virtual required const 🔗
Devuelve un array de características específicas de la plataforma para el preset especificado.
Texture2D _get_run_icon() virtual const 🔗
Devuelve el icono del botón del menú de implementación con un solo clic. El icono debe ser de 16×16 píxeles, ajustado a la escala actual del editor (véase EditorInterface.get_editor_scale()).
bool _has_valid_export_configuration(preset: EditorExportPreset, debug: bool) virtual required const 🔗
Devuelve true si la configuración de exportación es válida.
bool _has_valid_project_configuration(preset: EditorExportPreset) virtual required const 🔗
Devuelve true si la configuración del proyecto es válida.
bool _is_executable(path: String) virtual const 🔗
Devuelve true si el archivo especificado es un ejecutable válido (ejecutable nativo o script) para la plataforma de destino.
Devuelve true si las opciones de implementación con un solo clic se han cambiado y la interfaz del editor debería actualizarse.
Error _run(preset: EditorExportPreset, device: int, debug_flags: BitField[DebugFlags]) virtual 🔗
Este método se llama cuando se selecciona la opción del menú de implementación con un solo clic device.
La implementación debería exportar el proyecto a una ubicación temporal, cargarlo y ejecutarlo en el device específico, o realizar otra acción asociada con el elemento del menú.
bool _should_update_export_options() virtual 🔗
Devuelve true si la lista de opciones de exportación ha cambiado y los preajustes deberían actualizarse.
String get_config_error() const 🔗
Devuelve el texto del mensaje de error de configuración actual. Este método solo debe llamarse desde las implementaciones de _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
bool get_config_missing_templates() const 🔗
Devuelve true si faltan plantillas de exportación en la configuración actual. Este método solo debe llamarse desde las implementaciones de _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
void set_config_error(error_text: String) const 🔗
Establece el texto del mensaje de error de configuración actual. Este método solo debe llamarse desde las implementaciones de _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
void set_config_missing_templates(missing_templates: bool) const 🔗
Establece en true si faltan plantillas de exportación en la configuración actual. Este método solo debe llamarse desde las implementaciones de _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().