EditorExportPlatformExtension
Базовый класс для пользовательских реализаций EditorExportPlatform (плагинов).
Базовый класс для пользовательских реализаций EditorExportPlatform (плагинов).
Внешние реализации EditorExportPlatform должны наследоваться от этого класса.
Чтобы использовать EditorExportPlatform, сначала зарегистрируйте его с помощью метода EditorPlugin.AddExportPlatform.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
EditorExportPlatformExtensionКонструктор
public EditorExportPlatformExtension();Методы35
GetConfigErrorstring
public string GetConfigError();Возвращает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.
stringGetConfigMissingTemplatesbool
public bool GetConfigMissingTemplates();Возвращает true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.
boolSetConfigErrorvoid
public void SetConfigError(string errorText);Устанавливает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.
| Имя | Тип | По умолчанию |
|---|---|---|
errorText | string | — |
SetConfigMissingTemplatesvoid
public void SetConfigMissingTemplates(bool missingTemplates);Установите true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.
| Имя | Тип | По умолчанию |
|---|---|---|
missingTemplates | bool | — |
_CanExportbool
public virtual bool _CanExport(EditorExportPreset preset, bool debug);Возвращает true, если указанный preset действителен и может быть экспортирован. Используйте EditorExportPlatformExtension.SetConfigError и EditorExportPlatformExtension.SetConfigMissingTemplates для установки подробностей ошибки.
Обычные реализации вызывают EditorExportPlatformExtension._HasValidExportConfiguration и EditorExportPlatformExtension._HasValidProjectConfiguration, чтобы определить, возможен ли экспорт.
Уборка
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
bool_Cleanupvoid
public virtual void _Cleanup();Вызывается редактором перед отменой регистрации платформы.
_ExportPackError
public virtual Error _ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);Создает архив PCK в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе PCK в качестве типа файла.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | — |
Error_ExportPackPatchError
public virtual Error _ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches, EditorExportPlatform.DebugFlags flags);Создает архив патча PCK в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Этот метод вызывается при нажатии кнопки "Экспорт PCK/ZIP" в диалоговом окне экспорта с включенным "Экспортировать как патч" и выбором PCK в качестве типа файла.
Примечание: Патчи, предоставленные в patches, уже были загружены при вызове этого метода и просто предоставляются в качестве контекста. Если пусто, вместо этого загружаются патчи, определенные в экспортном пресете.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | string[] | — |
flags | EditorExportPlatform.DebugFlags | — |
Error_ExportProjectError
public virtual Error _ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);Создает полный проект в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт» в диалоговом окне экспорта.
Эта реализация метода может вызывать EditorExportPlatform.SavePack или EditorExportPlatform.SaveZip для использования процесса экспорта PCK/ZIP по умолчанию или вызывать EditorExportPlatform.ExportProjectFiles и реализовывать пользовательский обратный вызов для обработки каждого экспортированного файла.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | — |
Error_ExportZipError
public virtual Error _ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);Создайте ZIP-архив в path для указанного preset.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе ZIP в качестве типа файла.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | — |
Error_ExportZipPatchError
public virtual Error _ExportZipPatch(EditorExportPreset preset, bool debug, string path, string[] patches, EditorExportPlatform.DebugFlags flags);Создайте архив ZIP в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего исправления.
Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта с включенным «Экспортировать как Патч» и выбором ZIP в качестве типа файла.
Примечание: Патчи, предоставленные в patches, уже были загружены при вызове этого метода и просто предоставляются в качестве контекста. Если пусто, вместо этого загружаются патчи, определенные в экспортном пресете.
####_get_binary_Treens
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | string[] | — |
flags | EditorExportPlatform.DebugFlags | — |
Error_GetBinaryExtensionsstring[]
public virtual string[] _GetBinaryExtensions(EditorExportPreset preset);Возвращает массив поддерживаемых двоичных расширений для полного экспорта проекта.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
string[]_GetDebugProtocolstring
public virtual string _GetDebugProtocol();Возвращает протокол, используемый для удаленной отладки. Реализация по умолчанию возвращает tcp://.
#######получение_показатель_архитектура
string_GetDeviceArchitecturestring
public virtual string _GetDeviceArchitecture(int device);Возвращает архитектуру устройства для дистанционного развертывания.
######get_Export_option_reparation_beak
| Имя | Тип | По умолчанию |
|---|---|---|
device | int | — |
string_GetExportOptionVisibilitybool
public virtual bool _GetExportOptionVisibility(EditorExportPreset preset, string option);Проверяет option и возвращает видимость для указанного preset. Реализация по умолчанию возвращает true для всех параметров.
#######get_Export_option_requertion_
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
option | string | — |
bool_GetExportOptionWarningstring
public virtual string _GetExportOptionWarning(EditorExportPreset preset, StringName option);Проверяет option и возвращает предупреждающее сообщение для указанного preset. Реализация по умолчанию возвращает пустую строку для всех параметров.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
option | StringName | — |
string_GetExportOptionsReckfell.Collections.Array<Reckfell.Collections.Dictionary>
public virtual Reckfell.Collections.Array<Reckfell.Collections.Dictionary> _GetExportOptions();Возвращает список свойств в виде Reckfell.Collections.Array словарей. Каждый Reckfell.Collections.Dictionary должен содержать как минимум записи name: StringName и type: Variant.Type.
Кроме того, поддерживаются следующие ключи:
hint: PropertyHinthint_string: Stringusage: PropertyUsageFlagsclass_name: StringNamedefault_value: Variant, значение свойства по умолчанию.update_visibility: bool, если установлено значениеtrue,EditorExportPlatformExtension._GetExportOptionVisibilityвызывается для каждого свойства при изменении этого свойства.required: bool, если установлено значениеtrue, предупреждения этого свойства являются критическими и должны быть разрешены, чтобы сделать экспорт возможным. Это значение является подсказкой для реализацииEditorExportPlatformExtension._HasValidExportConfigurationи не используется движком напрямую. См. такжеReckfellObject.GetPropertyList.
Reckfell.Collections.Array<Reckfell.Collections.Dictionary>_GetLogoTexture2D
public virtual Texture2D _GetLogo();Возвращает логотип платформы, отображаемый в диалоговом окне экспорта. Размер логотипа должен быть 32×32 пикселя с поправкой на текущий масштаб редактора (см. EditorInterface.GetEditorScale).
Texture2D_GetNamestring
public virtual string _GetName();Возвращает имя экспортной платформы.
######получение_вариант_икон
string_GetOptionIconTexture2D
public virtual Texture2D _GetOptionIcon(int device);Возвращает значок объекта для указанного device значок должен быть 16×16 пикселей, скорректированных по текущей шкале редактора (см. EditorInterface.GetEditorScale).
| Имя | Тип | По умолчанию |
|---|---|---|
device | int | — |
Texture2D_GetOptionLabelstring
public virtual string _GetOptionLabel(int device);Возвращает удалённое развертывание лейбла меню для указанного device.
| Имя | Тип | По умолчанию |
|---|---|---|
device | int | — |
string_GetOptionTooltipstring
public virtual string _GetOptionTooltip(int device);Возвращает дистанционное развертывание инструментов меню для указанного device.
####get options_count
| Имя | Тип | По умолчанию |
|---|---|---|
device | int | — |
string_GetOptionsCountint
public virtual int _GetOptionsCount();Возвращает количество устройств (или других опций), имеющихся в меню дистанционного развертывания.
#####_get_options_tooltip
int_GetOptionsTooltipstring
public virtual string _GetOptionsTooltip();Возвращает подсказку кнопки дистанционного развертывания.
string_GetOsNamestring
public virtual string _GetOsName();Цель возвращения OS имя.
######_платформа_декорации
string_GetPlatformFeaturesstring[]
public virtual string[] _GetPlatformFeatures();Возвращает массив специфичных для платформы функций и возможностей.
string[]_GetPresetFeaturesstring[]
public virtual string[] _GetPresetFeatures(EditorExportPreset preset);Возвращает массив специфичных для платформы функций и возможностей для указанного preset.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
string[]_GetRunIconTexture2D
public virtual Texture2D _GetRunIcon();Верните значок кнопки дистанционное развертывание. Значок должен быть 16×16 пикселей, скорректированных по текущей шкале редактора (см. EditorInterface.GetEditorScale).
Texture2D_HasValidExportConfigurationbool
public virtual bool _HasValidExportConfiguration(EditorExportPreset preset, bool debug);Возвращает true, если конфигурация экспорта действительна.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
bool_HasValidProjectConfigurationbool
public virtual bool _HasValidProjectConfiguration(EditorExportPreset preset);Возвращает true, если конфигурация проекта действительна.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
bool_Initializevoid
public virtual void _Initialize();Инициализирует плагин. Вызывается редактором при регистрации платформы.
_IsExecutablebool
public virtual bool _IsExecutable(string path);Возвращает true, если указанный файл является допустимым исполняемым файлом (собственным исполняемым файлом или скриптом) для целевой платформы.
| Имя | Тип | По умолчанию |
|---|---|---|
path | string | — |
bool_PollExportbool
public virtual bool _PollExport();Returns (Возврат) true - при изменении вариантов дистанционного развертывания и обновлении интерфейса редакторов.
bool_RunError
public virtual Error _Run(EditorExportPreset preset, int device, EditorExportPlatform.DebugFlags debugFlags);Этот метод называется, когда device Выбран параметр дистанционного развертывания.
Осуществление должно осуществляться в целях осуществления проекта на временной основе, загрузки и выполнения конкретных задач. device, или выполнить другое действие, связанное с пунктом меню.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
device | int | — |
debugFlags | EditorExportPlatform.DebugFlags | — |
Error_ShouldUpdateExportOptionsbool
public virtual bool _ShouldUpdateExportOptions();Возвращает true, если список параметров экспорта изменен и предустановки должны быть обновлены.
bool