EditorExportPlatform
Определяет поддерживаемую платформу экспорта и внутренне обеспечивает функциональность экспорта на эту платформу.
Определяет поддерживаемую платформу экспорта и внутренне обеспечивает функциональность экспорта на эту платформу.
Базовый ресурс, который обеспечивает функциональность экспорта сборки выпуска проекта на платформу из редактора. Сохраняет метаданные, специфичные для платформы, такие как имя и поддерживаемые функции платформы, и выполняет экспорт проектов, файлов PCK и файлов ZIP. Использует шаблон экспорта для платформы, предоставленный во время экспорта проекта.
Используется в скриптах EditorExportPlugin для настройки платформенно-специфической настройки сцен и ресурсов. Подробнее см. EditorExportPlugin._BeginCustomizeScenes и EditorExportPlugin._BeginCustomizeResources.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Методы34
AddMessagevoid
public void AddMessage(EditorExportPlatform.ExportMessageType type, string category, string message);Добавляет сообщение в журнал экспорта, которое будет отображено после завершения экспорта.
| Имя | Тип | По умолчанию |
|---|---|---|
type | EditorExportPlatform.ExportMessageType | — |
category | string | — |
message | string | — |
ClearMessagesvoid
public void ClearMessages();Очищает журнал экспорта.
CreatePresetEditorExportPreset
public EditorExportPreset CreatePreset();Создайте новый пресет для этой платформы.
EditorExportPresetExportPackError
public Error ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);Создает архив PCK по адресу path для указанного preset.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | (EditorExportPlatform.DebugFlags)0 |
ErrorExportPackPatch2 перегрузки
public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);Создает архив патча PCK в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Примечание: patches — это необязательное переопределение набора патчей, определенных в экспортном пресете. Если пусто, вместо него будут использоваться патчи, определенные в экспортном пресете.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | ReadOnlySpan<string> | — |
flags | EditorExportPlatform.DebugFlags | — |
Errorpublic Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);Создает архив патча PCK в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Примечание: patches — это необязательное переопределение набора патчей, определенных в экспортном пресете. Если пусто, вместо него будут использоваться патчи, определенные в экспортном пресете.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | string[] | null |
flags | EditorExportPlatform.DebugFlags | (EditorExportPlatform.DebugFlags)0 |
patchesЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<string>().
ErrorExportProject2 перегрузки
public Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);Создает полноценный проект по адресу path для указанного preset. Если notify имеет значение true, плагины, использующие EditorExportPlugin._ExportBegin, будут вызываться в процессе.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | — |
Errorpublic Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0, bool notify = true);Создает полноценный проект по адресу path для указанного preset. Если notify имеет значение true, плагины, использующие EditorExportPlugin._ExportBegin, будут вызываться в процессе.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | (EditorExportPlatform.DebugFlags)0 |
notify | bool | true |
ErrorExportProjectFilesError
public Error ExportProjectFiles(EditorExportPreset preset, bool debug, Callable saveCb, Callable sharedCb = default);Файлы проектов экспорта для конкретного предварительного набора. Этот метод может быть использован для внедрения формата экспорта товаров, за исключением ПКК и ZIP. Для каждого экспортируемого файла требуется один из отзывов.
save_cb , необходимо получить все экспортированные файлы и представить следующие аргументы: info: Dictionary, file_data: PackedByteArray. . . . . info Словарь содержит следующие значения: path: String, source_path: String, file_index: int, file_count: int.
shared_cb предлагается экспортировать общие/статистические библиотеки коренных народов и привести следующие аргументы: file_path: String, tags: PackedStringArray, target_folder: String.
Примечание: file_index и file_count Они предназначены только для отслеживания прогресса и не обязательно являются уникальными и точными.
Примечание: Подписание save_cb 4.8 Существует код совместимости для автоматической обработки прежняя подпись если пропущенное сообщение имеет 7 аргументов.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
saveCb | Callable | — |
sharedCb | Callable | default |
ErrorExportZipError
public Error ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);Создать ZIP-архив по адресу path для указанного preset.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
flags | EditorExportPlatform.DebugFlags | (EditorExportPlatform.DebugFlags)0 |
ErrorExportZipPatch2 перегрузки
public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);Создайте архив ZIP патча в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Примечание: patches — это необязательное переопределение набора патчей, определенных в экспортном пресете. Если пусто, вместо него будут использоваться патчи, определенные в экспортном пресете.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | ReadOnlySpan<string> | — |
flags | EditorExportPlatform.DebugFlags | — |
Errorpublic Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);Создайте архив ZIP патча в path для указанного preset, содержащий только файлы, которые были изменены с момента последнего патча.
Примечание: patches — это необязательное переопределение набора патчей, определенных в экспортном пресете. Если пусто, вместо него будут использоваться патчи, определенные в экспортном пресете.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
patches | string[] | null |
flags | EditorExportPlatform.DebugFlags | (EditorExportPlatform.DebugFlags)0 |
patchesЕсли параметр не имеет значения, то значение по умолчанию: Array.Empty<string>().
ErrorFindExportTemplateReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary FindExportTemplate(string templateFileName);Находит шаблон экспорта для платформы и возвращает Reckfell.Collections.Dictionary со следующими ключами: path: String и error: String. Этот метод предоставляется для удобства, и пользовательские платформы экспорта не обязаны его использовать или хранить шаблоны экспорта так же, как официальные шаблоны.
| Имя | Тип | По умолчанию |
|---|---|---|
templateFileName | string | — |
Reckfell.Collections.DictionaryGenExportFlagsstring[]
public string[] GenExportFlags(EditorExportPlatform.DebugFlags flags);Генерирует массив аргументов командной строки для шаблонов экспорта по умолчанию для флагов отладки и настроек редактора.
| Имя | Тип | По умолчанию |
|---|---|---|
flags | EditorExportPlatform.DebugFlags | — |
string[]GetCurrentPresetsReckfell.Collections.Array
public Reckfell.Collections.Array GetCurrentPresets();Возвращает массив EditorExportPreset для этой платформы.
Reckfell.Collections.ArrayGetForcedExportFiles2 перегрузки
public static string[] GetForcedExportFiles();Возвращает массив имен основных файлов, которые всегда следует экспортировать независимо от предустановленной конфигурации.
string[]public static string[] GetForcedExportFiles(EditorExportPreset preset = null);Возвращает массив имен основных файлов, которые всегда следует экспортировать независимо от предустановленной конфигурации.
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | null |
string[]GetInternalExportFilesReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary GetInternalExportFiles(EditorExportPreset preset, bool debug);Возвращает дополнительные файлы, которые всегда должны экспортироваться независимо от предустановленной конфигурации и не являются частью исходного кода проекта. Возвращаемый Reckfell.Collections.Dictionary содержит ключи имени файла (string) и соответствующие им необработанные данные (byte[]).
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
Reckfell.Collections.DictionaryGetMessageCategorystring
public string GetMessageCategory(int index);Возвращает категорию сообщения для сообщения с заданным index.
| Имя | Тип | По умолчанию |
|---|---|---|
index | int | — |
stringGetMessageCountint
public int GetMessageCount();Возвращает количество сообщений в журнале экспорта.
intGetMessageTextstring
public string GetMessageText(int index);Возвращает текст сообщения с заданным index.
| Имя | Тип | По умолчанию |
|---|---|---|
index | int | — |
stringGetMessageTypeEditorExportPlatform.ExportMessageType
public EditorExportPlatform.ExportMessageType GetMessageType(int index);Возвращает тип сообщения с заданным index.
| Имя | Тип | По умолчанию |
|---|---|---|
index | int | — |
EditorExportPlatform.ExportMessageTypeGetOsNamestring
public string GetOsName();Возвращает имя экспортируемой операционной системы, обрабатываемой этим классом EditorExportPlatform, как понятную строку. Возможные возвращаемые значения: Windows, Linux, macOS, Android, iOS, и Web.
stringGetWorstMessageTypeEditorExportPlatform.ExportMessageType
public EditorExportPlatform.ExportMessageType GetWorstMessageType();Возвращает наиболее серьезный тип сообщения, присутствующий в данный момент в журнале экспорта.
EditorExportPlatform.ExportMessageTypeSavePackReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary SavePack(EditorExportPreset preset, bool debug, string path, bool embed = false);Сохраняет архив PCK и возвращает Reckfell.Collections.Dictionary со следующими ключами: result: Error, so_files: Array (массив общих/статических объектов, содержащий словари со следующими ключами: path: String, tags: PackedStringArray и target_folder: String).
Если embed равен true, содержимое PCK добавляется в конец файла path и возвращаемый Reckfell.Collections.Dictionary дополнительно включает следующие ключи: embedded_start: int (смещение внедренного PCK) и embedded_size: int (размер внедренного PCK).
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
embed | bool | false |
Reckfell.Collections.DictionarySavePackPatchReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary SavePackPatch(EditorExportPreset preset, bool debug, string path);Сохраняет архив исправлений PCK и возвращает Reckfell.Collections.Dictionary со следующими ключами: result: Error, so_files: Array (массив общих/статических объектов, содержащий словари со следующими ключами: path: String, tags: PackedStringArray и target_folder: String).
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
Reckfell.Collections.DictionarySaveZipReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary SaveZip(EditorExportPreset preset, bool debug, string path);Сохраняет ZIP-архив и возвращает Reckfell.Collections.Dictionary со следующими ключами: result: Error, so_files: Array (массив общих/статических объектов, содержащий словари со следующими ключами: path: String, tags: PackedStringArray и target_folder: String).
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
Reckfell.Collections.DictionarySaveZipPatchReckfell.Collections.Dictionary
public Reckfell.Collections.Dictionary SaveZipPatch(EditorExportPreset preset, bool debug, string path);Сохраняет архив ZIP с исправлениями и возвращает Reckfell.Collections.Dictionary со следующими ключами: result: Error, so_files: Array (массив общих/статических объектов, содержащий словари со следующими ключами: path: String, tags: PackedStringArray и target_folder: String).
| Имя | Тип | По умолчанию |
|---|---|---|
preset | EditorExportPreset | — |
debug | bool | — |
path | string | — |
Reckfell.Collections.DictionarySshPushToRemote2 перегрузки
public Error SshPushToRemote(string host, string port, ReadOnlySpan<string> scpArgs, string srcFile, string dstFile);Загружает указанный файл по протоколу SCP на удаленный хост.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
scpArgs | ReadOnlySpan<string> | — |
srcFile | string | — |
dstFile | string | — |
Errorpublic Error SshPushToRemote(string host, string port, string[] scpArgs, string srcFile, string dstFile);Загружает указанный файл по протоколу SCP на удаленный хост.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
scpArgs | string[] | — |
srcFile | string | — |
dstFile | string | — |
ErrorSshRunOnRemote2 перегрузки
public Error SshRunOnRemote(string host, string port, ReadOnlySpan<string> sshArg, string cmdArgs, Reckfell.Collections.Array output, int portFwd);Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает вывод команды в output.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
sshArg | ReadOnlySpan<string> | — |
cmdArgs | string | — |
output | Reckfell.Collections.Array | — |
portFwd | int | — |
Errorpublic Error SshRunOnRemote(string host, string port, string[] sshArg, string cmdArgs, Reckfell.Collections.Array output = null, int portFwd = -1);Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает вывод команды в output.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
sshArg | string[] | — |
cmdArgs | string | — |
output | Reckfell.Collections.Array | null |
portFwd | int | -1 |
ErrorSshRunOnRemoteNoWait2 перегрузки
public long SshRunOnRemoteNoWait(string host, string port, ReadOnlySpan<string> sshArgs, string cmdArgs, int portFwd);Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает идентификатор процесса (на удаленном хосте), не дожидаясь завершения команды.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
sshArgs | ReadOnlySpan<string> | — |
cmdArgs | string | — |
portFwd | int | — |
longpublic long SshRunOnRemoteNoWait(string host, string port, string[] sshArgs, string cmdArgs, int portFwd = -1);Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает идентификатор процесса (на удаленном хосте), не дожидаясь завершения команды.
| Имя | Тип | По умолчанию |
|---|---|---|
host | string | — |
port | string | — |
sshArgs | string[] | — |
cmdArgs | string | — |
portFwd | int | -1 |
longEditorExportPlatform.DebugFlags
| Значение | Описание |
|---|---|
DumbClient = 1 | Флаг устанавливается, если отлаживаемый удалённо проект должен использовать удалённую файловую систему. Если он установлен, |
RemoteDebug = 2 | Флаг устанавливается, если включена удалённая отладка. Если он установлен, |
RemoteDebugLocalhost = 4 | Флаг устанавливается, если удаленно отлаживаемый проект запущен на локальном хосте. Если установлено, |
ViewCollisions = 8 | Флаг устанавливается, если включена опция удалённой отладки «Видимые формы столкновений». Если этот флаг установлен, |
ViewNavigation = 16 | Флаг устанавливается, если включена опция удалённой отладки «Видимая навигация». Если она установлена, |
EditorExportPlatform.ExportMessageType
| Значение | Описание |
|---|---|
Error = 3 | Тип сообщения для сообщений об ошибках, которые необходимо устранить и которые приводят к сбою экспорта. |
Info = 1 | Тип сообщения для информационных сообщений, не влияющих на экспорт. |
None = 0 | Неверный тип сообщения, используемый в качестве значения по умолчанию, если тип не указан. |
Warning = 2 | Тип сообщения для предупреждающих сообщений, на которые следует обратить внимание, но которые все равно позволят завершить экспорт. |