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...
EditorExportPlatformExtension
Наследует: EditorExportPlatform < RefCounted < Object
Базовый класс для пользовательских реализаций EditorExportPlatform (плагинов).
Описание
Внешние реализации EditorExportPlatform должны наследоваться от этого класса.
Чтобы использовать EditorExportPlatform, сначала зарегистрируйте его с помощью метода EditorPlugin.add_export_platform().
Методы
Описания метода
bool _can_export(preset: EditorExportPreset, debug: bool) virtual const 🔗
Возвращает true, если указанный preset действителен и может быть экспортирован. Используйте set_config_error() и set_config_missing_templates() для установки подробностей ошибки.
Обычные реализации вызывают _has_valid_export_configuration() и _has_valid_project_configuration(), чтобы определить, возможен ли экспорт.
void _cleanup() virtual 🔗
Вызывается редактором перед отменой регистрации платформы.
Error _export_pack(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Создает архив PCK в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе PCK в качестве типа файла.
Error _export_pack_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Создает архив патча PCK в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Этот метод вызывается при нажатии кнопки "Экспорт PCK/ZIP" в диалоговом окне экспорта с включенным "Экспортировать как патч" и выбором PCK в качестве типа файла.
Примечание: Патчи, предоставленные в patches, уже были загружены при вызове этого метода и просто предоставляются в качестве контекста. Если пусто, вместо этого загружаются патчи, определенные в экспортном пресете.
Error _export_project(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual required 🔗
Создает полный проект в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт» в диалоговом окне экспорта.
Эта реализация метода может вызывать EditorExportPlatform.save_pack() или EditorExportPlatform.save_zip() для использования процесса экспорта PCK/ZIP по умолчанию или вызывать EditorExportPlatform.export_project_files() и реализовывать пользовательский обратный вызов для обработки каждого экспортированного файла.
Error _export_zip(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Создайте ZIP-архив в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе ZIP в качестве типа файла.
Error _export_zip_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Создайте архив ZIP в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего исправления.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта с включенным «Экспортировать как Патч» и выбором ZIP в качестве типа файла.
Примечание: Патчи, предоставленные в patches, уже были загружены при вызове этого метода и просто предоставляются в качестве контекста. Если пусто, вместо этого загружаются патчи, определенные в экспортном пресете.
PackedStringArray _get_binary_extensions(preset: EditorExportPreset) virtual required const 🔗
Возвращает массив поддерживаемых двоичных расширений для полного экспорта проекта.
String _get_debug_protocol() virtual const 🔗
Возвращает протокол, используемый для удаленной отладки. Реализация по умолчанию возвращает tcp://.
String _get_device_architecture(device: int) virtual const 🔗
Возвращает архитектуру устройства для развертывания в один клик.
bool _get_export_option_visibility(preset: EditorExportPreset, option: String) virtual const 🔗
Проверяет option и возвращает видимость для указанного preset. Реализация по умолчанию возвращает true для всех параметров.
String _get_export_option_warning(preset: EditorExportPreset, option: StringName) virtual const 🔗
Проверяет option и возвращает предупреждающее сообщение для указанного preset. Реализация по умолчанию возвращает пустую строку для всех параметров.
Array[Dictionary] _get_export_options() virtual const 🔗
Возвращает список свойств в виде Array словарей. Каждый Dictionary должен содержать как минимум записи name: StringName и type: Variant.Type.
Кроме того, поддерживаются следующие ключи:
hint: PropertyHinthint_string: Stringusage: PropertyUsageFlagsclass_name: StringNamedefault_value: Variant, значение свойства по умолчанию.update_visibility: bool, если установлено значениеtrue, _get_export_option_visibility() вызывается для каждого свойства при изменении этого свойства.required: bool, если установлено значениеtrue, предупреждения этого свойства являются критическими и должны быть разрешены, чтобы сделать экспорт возможным. Это значение является подсказкой для реализации _has_valid_export_configuration() и не используется движком напрямую.
См. также Object._get_property_list().
Texture2D _get_logo() virtual required const 🔗
Возвращает логотип платформы, отображаемый в диалоговом окне экспорта. Размер логотипа должен быть 32×32 пикселя с поправкой на текущий масштаб редактора (см. EditorInterface.get_editor_scale()).
String _get_name() virtual required const 🔗
Возвращает имя экспортной платформы.
Texture2D _get_option_icon(device: int) virtual const 🔗
Возвращает значок элемента для указанного device в меню быстрого развёртывания. Размер значка должен быть 16×16 пикселей с учётом текущего масштаба редактора (см. EditorInterface.get_editor_scale()).
String _get_option_label(device: int) virtual const 🔗
Возвращает метку элемента меню «Развернуть одним щелчком» для указанного device.
String _get_option_tooltip(device: int) virtual const 🔗
Возвращает всплывающую подсказку элемента меню развертывания одним щелчком для указанного device.
int _get_options_count() virtual const 🔗
Возвращает количество устройств (или других параметров), доступных в меню развертывания одним щелчком мыши.
String _get_options_tooltip() virtual const 🔗
Возвращает подсказку кнопки развертывания меню одним щелчком.
String _get_os_name() virtual required const 🔗
Возвращает имя целевой ОС.
PackedStringArray _get_platform_features() virtual required const 🔗
Возвращает массив специфичных для платформы функций и возможностей.
PackedStringArray _get_preset_features(preset: EditorExportPreset) virtual required const 🔗
Возвращает массив специфичных для платформы функций и возможностей для указанного preset.
Texture2D _get_run_icon() virtual const 🔗
Возвращает значок кнопки быстрого развёртывания меню. Размер значка должен быть 16×16 пикселей с учётом текущего масштаба редактора (см. EditorInterface.get_editor_scale()).
bool _has_valid_export_configuration(preset: EditorExportPreset, debug: bool) virtual required const 🔗
Возвращает true, если конфигурация экспорта действительна.
bool _has_valid_project_configuration(preset: EditorExportPreset) virtual required const 🔗
Возвращает true, если конфигурация проекта действительна.
void _initialize() virtual 🔗
Инициализирует плагин. Вызывается редактором при регистрации платформы.
bool _is_executable(path: String) virtual const 🔗
Возвращает true, если указанный файл является допустимым исполняемым файлом (собственным исполняемым файлом или скриптом) для целевой платформы.
Возвращает true, если параметры развертывания в один клик изменены и интерфейс редактора необходимо обновить.
Error _run(preset: EditorExportPreset, device: int, debug_flags: BitField[DebugFlags]) virtual 🔗
Этот метод вызывается, когда выбрана опция меню развертывания одним щелчком device.
Реализация должна экспортировать проект во временное местоположение, загрузить и запустить его на определенном device или выполнить другое действие, связанное с элементом меню.
bool _should_update_export_options() virtual 🔗
Возвращает true, если список параметров экспорта изменен и предустановки должны быть обновлены.
String get_config_error() const 🔗
Возвращает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций _can_export(), _has_valid_export_configuration() или _has_valid_project_configuration().
bool get_config_missing_templates() const 🔗
Возвращает true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций _can_export(), _has_valid_export_configuration() или _has_valid_project_configuration().
void set_config_error(error_text: String) const 🔗
Устанавливает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций _can_export(), _has_valid_export_configuration() или _has_valid_project_configuration().
void set_config_missing_templates(missing_templates: bool) const 🔗
Установите true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций _can_export(), _has_valid_export_configuration() или _has_valid_project_configuration().