reckfellENGINE

EditorExportPlatform

Определяет поддерживаемую платформу экспорта и внутренне обеспечивает функциональность экспорта на эту платформу.

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

Определяет поддерживаемую платформу экспорта и внутренне обеспечивает функциональность экспорта на эту платформу.

Базовый ресурс, который обеспечивает функциональность экспорта сборки выпуска проекта на платформу из редактора. Сохраняет метаданные, специфичные для платформы, такие как имя и поддерживаемые функции платформы, и выполняет экспорт проектов, файлов PCK и файлов ZIP. Использует шаблон экспорта для платформы, предоставленный во время экспорта проекта. Используется в скриптах EditorExportPlugin для настройки платформенно-специфической настройки сцен и ресурсов. Подробнее см. EditorExportPlugin._BeginCustomizeScenes и EditorExportPlugin._BeginCustomizeResources.

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

Методы34

AddMessagevoid
# AddMessage
C#
public void AddMessage(EditorExportPlatform.ExportMessageType type, string category, string message);

Добавляет сообщение в журнал экспорта, которое будет отображено после завершения экспорта.

Параметры
ИмяТипПо умолчанию
typeEditorExportPlatform.ExportMessageType—
categorystring—
messagestring—
ClearMessagesvoid
# ClearMessages
C#
public void ClearMessages();

Очищает журнал экспорта.

CreatePresetEditorExportPreset
# CreatePreset
C#
public EditorExportPreset CreatePreset();

Создайте новый пресет для этой платформы.

Возвращает EditorExportPreset
ExportPackError
# ExportPack
C#
public Error ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Создает архив PCK по адресу path для указанного preset.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
flagsEditorExportPlatform.DebugFlags(EditorExportPlatform.DebugFlags)0
Возвращает Error
ExportPackPatch2 перегрузки
# ExportPackPatch · 1/2
C#
public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesReadOnlySpan<string>—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
# ExportPackPatch · 2/2
C#
public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesstring[]null
flagsEditorExportPlatform.DebugFlags(EditorExportPlatform.DebugFlags)0
patches

Если параметр не имеет значения, то значение по умолчанию: Array.Empty<string>().

Возвращает Error
ExportProject2 перегрузки
# ExportProject · 1/2
C#
public Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);

Создает полноценный проект по адресу path для указанного preset. Если notify имеет значение true, плагины, использующие EditorExportPlugin._ExportBegin, будут вызываться в процессе.

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

Создает полноценный проект по адресу path для указанного preset. Если notify имеет значение true, плагины, использующие EditorExportPlugin._ExportBegin, будут вызываться в процессе.

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
saveCbCallable—
sharedCbCallabledefault
Возвращает Error
ExportZipError
# ExportZip
C#
public Error ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Создать ZIP-архив по адресу path для указанного preset.

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
flagsEditorExportPlatform.DebugFlags(EditorExportPlatform.DebugFlags)0
Возвращает Error
ExportZipPatch2 перегрузки
# ExportZipPatch · 1/2
C#
public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesReadOnlySpan<string>—
flagsEditorExportPlatform.DebugFlags—
Возвращает Error
# ExportZipPatch · 2/2
C#
public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
patchesstring[]null
flagsEditorExportPlatform.DebugFlags(EditorExportPlatform.DebugFlags)0
patches

Если параметр не имеет значения, то значение по умолчанию: Array.Empty<string>().

Возвращает Error
FindExportTemplateReckfell.Collections.Dictionary
# FindExportTemplate
C#
public Reckfell.Collections.Dictionary FindExportTemplate(string templateFileName);

Находит шаблон экспорта для платформы и возвращает Reckfell.Collections.Dictionary со следующими ключами: path: String и error: String. Этот метод предоставляется для удобства, и пользовательские платформы экспорта не обязаны его использовать или хранить шаблоны экспорта так же, как официальные шаблоны.

Параметры
ИмяТипПо умолчанию
templateFileNamestring—
Возвращает Reckfell.Collections.Dictionary
GenExportFlagsstring[]
# GenExportFlags
C#
public string[] GenExportFlags(EditorExportPlatform.DebugFlags flags);

Генерирует массив аргументов командной строки для шаблонов экспорта по умолчанию для флагов отладки и настроек редактора.

Параметры
ИмяТипПо умолчанию
flagsEditorExportPlatform.DebugFlags—
Возвращает string[]
GetCurrentPresetsReckfell.Collections.Array
# GetCurrentPresets
C#
public Reckfell.Collections.Array GetCurrentPresets();

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

Возвращает Reckfell.Collections.Array
GetForcedExportFiles2 перегрузки
# GetForcedExportFiles · 1/2
C#
public static string[] GetForcedExportFiles();

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

Возвращает string[]
# GetForcedExportFiles · 2/2
C#
public static string[] GetForcedExportFiles(EditorExportPreset preset = null);

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

Параметры
ИмяТипПо умолчанию
presetEditorExportPresetnull
Возвращает string[]
GetInternalExportFilesReckfell.Collections.Dictionary
# GetInternalExportFiles
C#
public Reckfell.Collections.Dictionary GetInternalExportFiles(EditorExportPreset preset, bool debug);

Возвращает дополнительные файлы, которые всегда должны экспортироваться независимо от предустановленной конфигурации и не являются частью исходного кода проекта. Возвращаемый Reckfell.Collections.Dictionary содержит ключи имени файла (string) и соответствующие им необработанные данные (byte[]).

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
Возвращает Reckfell.Collections.Dictionary
GetMessageCategorystring
# GetMessageCategory
C#
public string GetMessageCategory(int index);

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

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

Возвращает количество сообщений в журнале экспорта.

Возвращает int
GetMessageTextstring
# GetMessageText
C#
public string GetMessageText(int index);

Возвращает текст сообщения с заданным index.

Параметры
ИмяТипПо умолчанию
indexint—
Возвращает string
GetMessageTypeEditorExportPlatform.ExportMessageType
# GetMessageType
C#
public EditorExportPlatform.ExportMessageType GetMessageType(int index);

Возвращает тип сообщения с заданным index.

Параметры
ИмяТипПо умолчанию
indexint—
Возвращает EditorExportPlatform.ExportMessageType
GetOsNamestring
# GetOsName
C#
public string GetOsName();

Возвращает имя экспортируемой операционной системы, обрабатываемой этим классом EditorExportPlatform, как понятную строку. Возможные возвращаемые значения: Windows, Linux, macOS, Android, iOS, и Web.

Возвращает string
GetWorstMessageTypeEditorExportPlatform.ExportMessageType
# GetWorstMessageType
C#
public EditorExportPlatform.ExportMessageType GetWorstMessageType();

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

Возвращает EditorExportPlatform.ExportMessageType
SavePackReckfell.Collections.Dictionary
# SavePack
C#
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).

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
embedboolfalse
Возвращает Reckfell.Collections.Dictionary
SavePackPatchReckfell.Collections.Dictionary
# SavePackPatch
C#
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).

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
Возвращает Reckfell.Collections.Dictionary
SaveZipReckfell.Collections.Dictionary
# SaveZip
C#
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).

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
Возвращает Reckfell.Collections.Dictionary
SaveZipPatchReckfell.Collections.Dictionary
# SaveZipPatch
C#
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).

Параметры
ИмяТипПо умолчанию
presetEditorExportPreset—
debugbool—
pathstring—
Возвращает Reckfell.Collections.Dictionary
SshPushToRemote2 перегрузки
# SshPushToRemote · 1/2
C#
public Error SshPushToRemote(string host, string port, ReadOnlySpan<string> scpArgs, string srcFile, string dstFile);

Загружает указанный файл по протоколу SCP на удаленный хост.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
scpArgsReadOnlySpan<string>—
srcFilestring—
dstFilestring—
Возвращает Error
# SshPushToRemote · 2/2
C#
public Error SshPushToRemote(string host, string port, string[] scpArgs, string srcFile, string dstFile);

Загружает указанный файл по протоколу SCP на удаленный хост.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
scpArgsstring[]—
srcFilestring—
dstFilestring—
Возвращает Error
SshRunOnRemote2 перегрузки
# SshRunOnRemote · 1/2
C#
public Error SshRunOnRemote(string host, string port, ReadOnlySpan<string> sshArg, string cmdArgs, Reckfell.Collections.Array output, int portFwd);

Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает вывод команды в output.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
sshArgReadOnlySpan<string>—
cmdArgsstring—
outputReckfell.Collections.Array—
portFwdint—
Возвращает Error
# SshRunOnRemote · 2/2
C#
public Error SshRunOnRemote(string host, string port, string[] sshArg, string cmdArgs, Reckfell.Collections.Array output = null, int portFwd = -1);

Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает вывод команды в output.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
sshArgstring[]—
cmdArgsstring—
outputReckfell.Collections.Arraynull
portFwdint-1
Возвращает Error
SshRunOnRemoteNoWait2 перегрузки
# SshRunOnRemoteNoWait · 1/2
C#
public long SshRunOnRemoteNoWait(string host, string port, ReadOnlySpan<string> sshArgs, string cmdArgs, int portFwd);

Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает идентификатор процесса (на удаленном хосте), не дожидаясь завершения команды.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
sshArgsReadOnlySpan<string>—
cmdArgsstring—
portFwdint—
Возвращает long
# SshRunOnRemoteNoWait · 2/2
C#
public long SshRunOnRemoteNoWait(string host, string port, string[] sshArgs, string cmdArgs, int portFwd = -1);

Выполняет указанную команду на удаленном хосте по протоколу SSH и возвращает идентификатор процесса (на удаленном хосте), не дожидаясь завершения команды.

Параметры
ИмяТипПо умолчанию
hoststring—
portstring—
sshArgsstring[]—
cmdArgsstring—
portFwdint-1
Возвращает long

EditorExportPlatform.DebugFlags

ЗначениеОписание
DumbClient = 1

Флаг устанавливается, если отлаживаемый удалённо проект должен использовать удалённую файловую систему. Если он установлен, EditorExportPlatform.GenExportFlags добавит аргументы командной строки --remote-fs и --remote-fs-password (если определён EditorSettings.filesystem/file_server/password) к возвращаемому списку.

RemoteDebug = 2

Флаг устанавливается, если включена удалённая отладка. Если он установлен, EditorExportPlatform.GenExportFlags добавит аргументы командной строки --remote-debug и --breakpoints (если точки останова выбраны в редакторе скриптов или добавлены плагином) к возвращаемому списку.

RemoteDebugLocalhost = 4

Флаг устанавливается, если удаленно отлаживаемый проект запущен на локальном хосте. Если установлено, EditorExportPlatform.GenExportFlags будет использовать localhost вместо EditorSettings.network/debug/remote_host в качестве удаленного хоста отладчика.

ViewCollisions = 8

Флаг устанавливается, если включена опция удалённой отладки «Видимые формы столкновений». Если этот флаг установлен, EditorExportPlatform.GenExportFlags добавит аргумент командной строки --debug-collisions к возвращаемому списку.

ViewNavigation = 16

Флаг устанавливается, если включена опция удалённой отладки «Видимая навигация». Если она установлена, EditorExportPlatform.GenExportFlags добавит аргумент командной строки --debug-navigation к возвращаемому списку.

EditorExportPlatform.ExportMessageType

ЗначениеОписание
Error = 3

Тип сообщения для сообщений об ошибках, которые необходимо устранить и которые приводят к сбою экспорта.

Info = 1

Тип сообщения для информационных сообщений, не влияющих на экспорт.

None = 0

Неверный тип сообщения, используемый в качестве значения по умолчанию, если тип не указан.

Warning = 2

Тип сообщения для предупреждающих сообщений, на которые следует обратить внимание, но которые все равно позволят завершить экспорт.

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

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

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

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