reckfellENGINE

EditorExportPlatformExtension

Базовый класс для пользовательских реализаций EditorExportPlatform (плагинов).

На этой странице
class EditorExportPlatformExtensionReckfellSharpEditorНаследует EditorExportPlatform

Базовый класс для пользовательских реализаций EditorExportPlatform (плагинов).

Внешние реализации EditorExportPlatform должны наследоваться от этого класса. Чтобы использовать EditorExportPlatform, сначала зарегистрируйте его с помощью метода EditorPlugin.AddExportPlatform.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

EditorExportPlatformExtensionКонструктор
# EditorExportPlatformExtension
C#
public EditorExportPlatformExtension();

Методы35

GetConfigErrorstring
# GetConfigError
C#
public string GetConfigError();

Возвращает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.

Возвращает string
GetConfigMissingTemplatesbool
# GetConfigMissingTemplates
C#
public bool GetConfigMissingTemplates();

Возвращает true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.

Возвращает bool
SetConfigErrorvoid
# SetConfigError
C#
public void SetConfigError(string errorText);

Устанавливает текст сообщения об ошибке текущей конфигурации. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.

Параметры
ИмяТипПо умолчанию
errorTextstring—
SetConfigMissingTemplatesvoid
# SetConfigMissingTemplates
C#
public void SetConfigMissingTemplates(bool missingTemplates);

Установите true, если в текущей конфигурации отсутствуют шаблоны экспорта. Этот метод следует вызывать только из реализаций EditorExportPlatformExtension._CanExport, EditorExportPlatformExtension._HasValidExportConfiguration или EditorExportPlatformExtension._HasValidProjectConfiguration.

Параметры
ИмяТипПо умолчанию
missingTemplatesbool—
_CanExportbool
# _CanExport
C#
public virtual bool _CanExport(EditorExportPreset preset, bool debug);

Возвращает true, если указанный preset действителен и может быть экспортирован. Используйте EditorExportPlatformExtension.SetConfigError и EditorExportPlatformExtension.SetConfigMissingTemplates для установки подробностей ошибки. Обычные реализации вызывают EditorExportPlatformExtension._HasValidExportConfiguration и EditorExportPlatformExtension._HasValidProjectConfiguration, чтобы определить, возможен ли экспорт.

Уборка

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
Возвращает bool
_Cleanupvoid
# _Cleanup
C#
public virtual void _Cleanup();

Вызывается редактором перед отменой регистрации платформы.

_ExportPackError
# _ExportPack
C#
public virtual Error _ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);

Создает архив PCK в path для указанного preset. Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе PCK в качестве типа файла.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
_ExportPackPatchError
# _ExportPackPatch
C#
public virtual Error _ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches, EditorExportPlatform.DebugFlags flags);

Создает архив патча PCK в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча. Этот метод вызывается при нажатии кнопки "Экспорт PCK/ZIP" в диалоговом окне экспорта с включенным "Экспортировать как патч" и выбором PCK в качестве типа файла. Примечание: Патчи, предоставленные в patches, уже были загружены при вызове этого метода и просто предоставляются в качестве контекста. Если пусто, вместо этого загружаются патчи, определенные в экспортном пресете.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesstring[]—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
_ExportProjectError
# _ExportProject
C#
public virtual Error _ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);

Создает полный проект в path для указанного preset. Этот метод вызывается при нажатии кнопки «Экспорт» в диалоговом окне экспорта. Эта реализация метода может вызывать EditorExportPlatform.SavePack или EditorExportPlatform.SaveZip для использования процесса экспорта PCK/ZIP по умолчанию или вызывать EditorExportPlatform.ExportProjectFiles и реализовывать пользовательский обратный вызов для обработки каждого экспортированного файла.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
_ExportZipError
# _ExportZip
C#
public virtual Error _ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);

Создайте ZIP-архив в path для указанного preset. Этот метод вызывается при нажатии кнопки «Экспорт PCK/ZIP» в диалоговом окне экспорта, при отключенном «Экспортировать как патч», и выборе ZIP в качестве типа файла.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
_ExportZipPatchError
# _ExportZipPatch
C#
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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesstring[]—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
_GetBinaryExtensionsstring[]
# _GetBinaryExtensions
C#
public virtual string[] _GetBinaryExtensions(EditorExportPreset preset);

Возвращает массив поддерживаемых двоичных расширений для полного экспорта проекта.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
Возвращает string[]
_GetDebugProtocolstring
# _GetDebugProtocol
C#
public virtual string _GetDebugProtocol();

Возвращает протокол, используемый для удаленной отладки. Реализация по умолчанию возвращает tcp://.

#######получение_показатель_архитектура

Возвращает string
_GetDeviceArchitecturestring
# _GetDeviceArchitecture
C#
public virtual string _GetDeviceArchitecture(int device);

Возвращает архитектуру устройства для дистанционного развертывания.

######get_Export_option_reparation_beak

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает string
_GetExportOptionVisibilitybool
# _GetExportOptionVisibility
C#
public virtual bool _GetExportOptionVisibility(EditorExportPreset preset, string option);

Проверяет option и возвращает видимость для указанного preset. Реализация по умолчанию возвращает true для всех параметров.

#######get_Export_option_requertion_

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
optionstring—
Возвращает bool
_GetExportOptionWarningstring
# _GetExportOptionWarning
C#
public virtual string _GetExportOptionWarning(EditorExportPreset preset, StringName option);

Проверяет option и возвращает предупреждающее сообщение для указанного preset. Реализация по умолчанию возвращает пустую строку для всех параметров.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
optionStringName—
Возвращает string
_GetExportOptionsReckfell.Collections.Array<Reckfell.Collections.Dictionary>
# _GetExportOptions
C#
public virtual Reckfell.Collections.Array<Reckfell.Collections.Dictionary> _GetExportOptions();

Возвращает список свойств в виде Reckfell.Collections.Array словарей. Каждый Reckfell.Collections.Dictionary должен содержать как минимум записи name: StringName и type: Variant.Type. Кроме того, поддерживаются следующие ключи:

  • hint: PropertyHint
  • hint_string: String
  • usage: PropertyUsageFlags
  • class_name: StringName
  • default_value: Variant, значение свойства по умолчанию.
  • update_visibility: bool, если установлено значение true, EditorExportPlatformExtension._GetExportOptionVisibility вызывается для каждого свойства при изменении этого свойства.
  • required: bool, если установлено значение true, предупреждения этого свойства являются критическими и должны быть разрешены, чтобы сделать экспорт возможным. Это значение является подсказкой для реализации EditorExportPlatformExtension._HasValidExportConfiguration и не используется движком напрямую. См. также ReckfellObject.GetPropertyList.
Возвращает Reckfell.Collections.Array<Reckfell.Collections.Dictionary>
_GetLogoTexture2D
# _GetLogo
C#
public virtual Texture2D _GetLogo();

Возвращает логотип платформы, отображаемый в диалоговом окне экспорта. Размер логотипа должен быть 32×32 пикселя с поправкой на текущий масштаб редактора (см. EditorInterface.GetEditorScale).

Возвращает Texture2D
_GetNamestring
# _GetName
C#
public virtual string _GetName();

Возвращает имя экспортной платформы.

######получение_вариант_икон

Возвращает string
_GetOptionIconTexture2D
# _GetOptionIcon
C#
public virtual Texture2D _GetOptionIcon(int device);

Возвращает значок объекта для указанного device значок должен быть 16×16 пикселей, скорректированных по текущей шкале редактора (см. EditorInterface.GetEditorScale).

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает Texture2D
_GetOptionLabelstring
# _GetOptionLabel
C#
public virtual string _GetOptionLabel(int device);

Возвращает удалённое развертывание лейбла меню для указанного device.

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает string
_GetOptionTooltipstring
# _GetOptionTooltip
C#
public virtual string _GetOptionTooltip(int device);

Возвращает дистанционное развертывание инструментов меню для указанного device.

####get options_count

Параметры
ИмяТипПо умолчанию
deviceint—
Возвращает string
_GetOptionsCountint
# _GetOptionsCount
C#
public virtual int _GetOptionsCount();

Возвращает количество устройств (или других опций), имеющихся в меню дистанционного развертывания.

#####_get_options_tooltip

Возвращает int
_GetOptionsTooltipstring
# _GetOptionsTooltip
C#
public virtual string _GetOptionsTooltip();

Возвращает подсказку кнопки дистанционного развертывания.

Возвращает string
_GetOsNamestring
# _GetOsName
C#
public virtual string _GetOsName();

Цель возвращения OS имя.

######_платформа_декорации

Возвращает string
_GetPlatformFeaturesstring[]
# _GetPlatformFeatures
C#
public virtual string[] _GetPlatformFeatures();

Возвращает массив специфичных для платформы функций и возможностей.

Возвращает string[]
_GetPresetFeaturesstring[]
# _GetPresetFeatures
C#
public virtual string[] _GetPresetFeatures(EditorExportPreset preset);

Возвращает массив специфичных для платформы функций и возможностей для указанного preset.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
Возвращает string[]
_GetRunIconTexture2D
# _GetRunIcon
C#
public virtual Texture2D _GetRunIcon();

Верните значок кнопки дистанционное развертывание. Значок должен быть 16×16 пикселей, скорректированных по текущей шкале редактора (см. EditorInterface.GetEditorScale).

Возвращает Texture2D
_HasValidExportConfigurationbool
# _HasValidExportConfiguration
C#
public virtual bool _HasValidExportConfiguration(EditorExportPreset preset, bool debug);

Возвращает true, если конфигурация экспорта действительна.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
Возвращает bool
_HasValidProjectConfigurationbool
# _HasValidProjectConfiguration
C#
public virtual bool _HasValidProjectConfiguration(EditorExportPreset preset);

Возвращает true, если конфигурация проекта действительна.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
Возвращает bool
_Initializevoid
# _Initialize
C#
public virtual void _Initialize();

Инициализирует плагин. Вызывается редактором при регистрации платформы.

_IsExecutablebool
# _IsExecutable
C#
public virtual bool _IsExecutable(string path);

Возвращает true, если указанный файл является допустимым исполняемым файлом (собственным исполняемым файлом или скриптом) для целевой платформы.

Параметры
ИмяТипПо умолчанию
pathstring—
Возвращает bool
_PollExportbool
# _PollExport
C#
public virtual bool _PollExport();

Returns (Возврат) true - при изменении вариантов дистанционного развертывания и обновлении интерфейса редакторов.

Возвращает bool
_RunError
# _Run
C#
public virtual Error _Run(EditorExportPreset preset, int device, EditorExportPlatform.DebugFlags debugFlags);

Этот метод называется, когда device Выбран параметр дистанционного развертывания. Осуществление должно осуществляться в целях осуществления проекта на временной основе, загрузки и выполнения конкретных задач. device, или выполнить другое действие, связанное с пунктом меню.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
deviceint—
debugFlagsEditorExportPlatform.DebugFlags—
Возвращает Error
_ShouldUpdateExportOptionsbool
# _ShouldUpdateExportOptions
C#
public virtual bool _ShouldUpdateExportOptions();

Возвращает true, если список параметров экспорта изменен и предустановки должны быть обновлены.

Возвращает bool
Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.