:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPlatformExtension.xml. .. _class_EditorExportPlatformExtension: EditorExportPlatformExtension ============================= **Inherits:** :ref:`EditorExportPlatform` **<** :ref:`RefCounted` **<** :ref:`Object` Base class for custom :ref:`EditorExportPlatform` implementations (plugins). .. rst-class:: classref-introduction-group Description ----------- External :ref:`EditorExportPlatform` implementations should inherit from this class. To use :ref:`EditorExportPlatform`, register it using the :ref:`EditorPlugin.add_export_platform()` method first. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_can_export`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_cleanup`\ (\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_pack`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_pack_patch`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_project`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| |required| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_zip`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_export_zip_patch`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_binary_extensions`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_debug_protocol`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_device_architecture`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_get_export_option_visibility`\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_export_option_warning`\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`StringName`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Dictionary`\] | :ref:`_get_export_options`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`_get_logo`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_name`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`_get_option_icon`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_option_label`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_option_tooltip`\ (\ device\: :ref:`int`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_options_count`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_options_tooltip`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`_get_os_name`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_platform_features`\ (\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_preset_features`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Texture2D` | :ref:`_get_run_icon`\ (\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_valid_export_configuration`\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_has_valid_project_configuration`\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_executable`\ (\ path\: :ref:`String`\ ) |virtual| |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_poll_export`\ (\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_run`\ (\ preset\: :ref:`EditorExportPreset`, device\: :ref:`int`, debug_flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_should_update_export_options`\ (\ ) |virtual| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_config_error`\ (\ ) |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_config_missing_templates`\ (\ ) |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_config_error`\ (\ error_text\: :ref:`String`\ ) |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_config_missing_templates`\ (\ missing_templates\: :ref:`bool`\ ) |const| | +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorExportPlatformExtension_private_method__can_export: .. rst-class:: classref-method :ref:`bool` **_can_export**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |const| :ref:`🔗` Returns ``true``, if specified ``preset`` is valid and can be exported. Use :ref:`set_config_error()` and :ref:`set_config_missing_templates()` to set error details. Usual implementation can call :ref:`_has_valid_export_configuration()` and :ref:`_has_valid_project_configuration()` to determine if export is possible. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__cleanup: .. rst-class:: classref-method |void| **_cleanup**\ (\ ) |virtual| :ref:`🔗` Called by the editor before platform is unregistered. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__export_pack: .. rst-class:: classref-method :ref:`Error` **_export_pack**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` Creates a PCK archive at ``path`` for the specified ``preset``. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and PCK is selected as a file type. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__export_pack_patch: .. rst-class:: classref-method :ref:`Error` **_export_pack_patch**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` Creates a patch PCK archive at ``path`` for the specified ``preset``, containing only the files that have changed since the last patch. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and PCK is selected as a file type. \ **Note:** The patches provided in ``patches`` have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__export_project: .. rst-class:: classref-method :ref:`Error` **_export_project**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| |required| :ref:`🔗` Creates a full project at ``path`` for the specified ``preset``. This method is called when "Export" button is pressed in the export dialog. This method implementation can call :ref:`EditorExportPlatform.save_pack()` or :ref:`EditorExportPlatform.save_zip()` to use default PCK/ZIP export process, or calls :ref:`EditorExportPlatform.export_project_files()` and implement custom callback for processing each exported file. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__export_zip: .. rst-class:: classref-method :ref:`Error` **_export_zip**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` Create a ZIP archive at ``path`` for the specified ``preset``. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" disabled, and ZIP is selected as a file type. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__export_zip_patch: .. rst-class:: classref-method :ref:`Error` **_export_zip_patch**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`, path\: :ref:`String`, patches\: :ref:`PackedStringArray`, flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` Create a ZIP archive at ``path`` for the specified ``preset``, containing only the files that have changed since the last patch. This method is called when "Export PCK/ZIP" button is pressed in the export dialog, with "Export as Patch" enabled, and ZIP is selected as a file type. \ **Note:** The patches provided in ``patches`` have already been loaded when this method is called and are merely provided as context. When empty the patches defined in the export preset have been loaded instead. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_binary_extensions: .. rst-class:: classref-method :ref:`PackedStringArray` **_get_binary_extensions**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` Returns array of supported binary extensions for the full project export. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_debug_protocol: .. rst-class:: classref-method :ref:`String` **_get_debug_protocol**\ (\ ) |virtual| |const| :ref:`🔗` Returns protocol used for remote debugging. Default implementation return ``tcp://``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_device_architecture: .. rst-class:: classref-method :ref:`String` **_get_device_architecture**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Returns device architecture for one-click deploy. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_export_option_visibility: .. rst-class:: classref-method :ref:`bool` **_get_export_option_visibility**\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Validates ``option`` and returns visibility for the specified ``preset``. Default implementation return ``true`` for all options. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_export_option_warning: .. rst-class:: classref-method :ref:`String` **_get_export_option_warning**\ (\ preset\: :ref:`EditorExportPreset`, option\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Validates ``option`` and returns warning message for the specified ``preset``. Default implementation return empty string for all options. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_export_options: .. rst-class:: classref-method :ref:`Array`\[:ref:`Dictionary`\] **_get_export_options**\ (\ ) |virtual| |const| :ref:`🔗` Returns a property list, as an :ref:`Array` of dictionaries. Each :ref:`Dictionary` must at least contain the ``name: StringName`` and ``type: Variant.Type`` entries. Additionally, the following keys are supported: - ``hint: PropertyHint``\ - ``hint_string: String``\ - ``usage: PropertyUsageFlags``\ - ``class_name: StringName``\ - ``default_value: Variant``, default value of the property. - ``update_visibility: bool``, if set to ``true``, :ref:`_get_export_option_visibility()` is called for each property when this property is changed. - ``required: bool``, if set to ``true``, this property warnings are critical, and should be resolved to make export possible. This value is a hint for the :ref:`_has_valid_export_configuration()` implementation, and not used by the engine directly. See also :ref:`Object._get_property_list()`. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_logo: .. rst-class:: classref-method :ref:`Texture2D` **_get_logo**\ (\ ) |virtual| |required| |const| :ref:`🔗` Returns the platform logo displayed in the export dialog. The logo should be 32×32 pixels, adjusted for the current editor scale (see :ref:`EditorInterface.get_editor_scale()`). .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_name: .. rst-class:: classref-method :ref:`String` **_get_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` Returns export platform name. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_option_icon: .. rst-class:: classref-method :ref:`Texture2D` **_get_option_icon**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Returns the item icon for the specified ``device`` in the one-click deploy menu. The icon should be 16×16 pixels, adjusted for the current editor scale (see :ref:`EditorInterface.get_editor_scale()`). .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_option_label: .. rst-class:: classref-method :ref:`String` **_get_option_label**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Returns one-click deploy menu item label for the specified ``device``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_option_tooltip: .. rst-class:: classref-method :ref:`String` **_get_option_tooltip**\ (\ device\: :ref:`int`\ ) |virtual| |const| :ref:`🔗` Returns one-click deploy menu item tooltip for the specified ``device``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_options_count: .. rst-class:: classref-method :ref:`int` **_get_options_count**\ (\ ) |virtual| |const| :ref:`🔗` Returns the number of devices (or other options) available in the one-click deploy menu. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_options_tooltip: .. rst-class:: classref-method :ref:`String` **_get_options_tooltip**\ (\ ) |virtual| |const| :ref:`🔗` Returns tooltip of the one-click deploy menu button. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_os_name: .. rst-class:: classref-method :ref:`String` **_get_os_name**\ (\ ) |virtual| |required| |const| :ref:`🔗` Returns target OS name. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_platform_features: .. rst-class:: classref-method :ref:`PackedStringArray` **_get_platform_features**\ (\ ) |virtual| |required| |const| :ref:`🔗` Returns array of platform specific features. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_preset_features: .. rst-class:: classref-method :ref:`PackedStringArray` **_get_preset_features**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` Returns array of platform specific features for the specified ``preset``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__get_run_icon: .. rst-class:: classref-method :ref:`Texture2D` **_get_run_icon**\ (\ ) |virtual| |const| :ref:`🔗` Returns the icon of the one-click deploy menu button. The icon should be 16×16 pixels, adjusted for the current editor scale (see :ref:`EditorInterface.get_editor_scale()`). .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__has_valid_export_configuration: .. rst-class:: classref-method :ref:`bool` **_has_valid_export_configuration**\ (\ preset\: :ref:`EditorExportPreset`, debug\: :ref:`bool`\ ) |virtual| |required| |const| :ref:`🔗` Returns ``true`` if export configuration is valid. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__has_valid_project_configuration: .. rst-class:: classref-method :ref:`bool` **_has_valid_project_configuration**\ (\ preset\: :ref:`EditorExportPreset`\ ) |virtual| |required| |const| :ref:`🔗` Returns ``true`` if project configuration is valid. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__is_executable: .. rst-class:: classref-method :ref:`bool` **_is_executable**\ (\ path\: :ref:`String`\ ) |virtual| |const| :ref:`🔗` Returns ``true`` if specified file is a valid executable (native executable or script) for the target platform. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__poll_export: .. rst-class:: classref-method :ref:`bool` **_poll_export**\ (\ ) |virtual| :ref:`🔗` Returns ``true`` if one-click deploy options are changed and editor interface should be updated. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__run: .. rst-class:: classref-method :ref:`Error` **_run**\ (\ preset\: :ref:`EditorExportPreset`, device\: :ref:`int`, debug_flags\: |bitfield|\[:ref:`DebugFlags`\]\ ) |virtual| :ref:`🔗` This method is called when ``device`` one-click deploy menu option is selected. Implementation should export project to a temporary location, upload and run it on the specific ``device``, or perform another action associated with the menu item. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_private_method__should_update_export_options: .. rst-class:: classref-method :ref:`bool` **_should_update_export_options**\ (\ ) |virtual| :ref:`🔗` Returns ``true`` if export options list is changed and presets should be updated. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_method_get_config_error: .. rst-class:: classref-method :ref:`String` **get_config_error**\ (\ ) |const| :ref:`🔗` Returns current configuration error message text. This method should be called only from the :ref:`_can_export()`, :ref:`_has_valid_export_configuration()`, or :ref:`_has_valid_project_configuration()` implementations. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_method_get_config_missing_templates: .. rst-class:: classref-method :ref:`bool` **get_config_missing_templates**\ (\ ) |const| :ref:`🔗` Returns ``true`` is export templates are missing from the current configuration. This method should be called only from the :ref:`_can_export()`, :ref:`_has_valid_export_configuration()`, or :ref:`_has_valid_project_configuration()` implementations. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_method_set_config_error: .. rst-class:: classref-method |void| **set_config_error**\ (\ error_text\: :ref:`String`\ ) |const| :ref:`🔗` Sets current configuration error message text. This method should be called only from the :ref:`_can_export()`, :ref:`_has_valid_export_configuration()`, or :ref:`_has_valid_project_configuration()` implementations. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPlatformExtension_method_set_config_missing_templates: .. rst-class:: classref-method |void| **set_config_missing_templates**\ (\ missing_templates\: :ref:`bool`\ ) |const| :ref:`🔗` Set to ``true`` is export templates are missing from the current configuration. This method should be called only from the :ref:`_can_export()`, :ref:`_has_valid_export_configuration()`, or :ref:`_has_valid_project_configuration()` implementations. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`