EditorExportPlatform

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

Adds a message to the export log that will be displayed when exporting ends.

public void ClearMessages();

Clears the export log.

public EditorExportPreset CreatePreset();

Create a new preset for this platform.

public Error ExportPack(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Creates a PCK archive at path for the specified preset.

public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);

Creates a patch PCK archive at path for the specified preset, containing only the files that have changed since the last patch. Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportPackPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Creates a patch PCK archive at path for the specified preset, containing only the files that have changed since the last patch. Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags);

Creates a full project at path for the specified preset. If notify is true, plugins using EditorExportPlugin._ExportBegin will be called during the process.

public Error ExportProject(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0, bool notify = true);

Creates a full project at path for the specified preset. If notify is true, plugins using EditorExportPlugin._ExportBegin will be called during the process.

public Error ExportProjectFiles(EditorExportPreset preset, bool debug, Callable saveCb, Callable sharedCb = default);

Exports project files for the specified preset. This method can be used to implement custom export format, other than PCK and ZIP. One of the callbacks is called for each exported file. save_cb is called for all exported files and have the following arguments: info: Dictionary, file_data: PackedByteArray. The info dictionary contains the following values: path: String, source_path: String, file_index: int, file_count: int. shared_cb is called for exported native shared/static libraries and have the following arguments: file_path: String, tags: PackedStringArray, target_folder: String. Note: file_index and file_count are intended for progress tracking only and aren't necessarily unique and precise. Note: The signature of save_cb changed in Reckfell. There is compatibility code to automatically handle the previous signature if the passed callable has 7 arguments.

public Error ExportZip(EditorExportPreset preset, bool debug, string path, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Create a ZIP archive at path for the specified preset.

public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, ReadOnlySpan<string> patches, EditorExportPlatform.DebugFlags flags);

Create a patch ZIP archive at path for the specified preset, containing only the files that have changed since the last patch. Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Error ExportZipPatch(EditorExportPreset preset, bool debug, string path, string[] patches = null, EditorExportPlatform.DebugFlags flags = (EditorExportPlatform.DebugFlags)0);

Create a patch ZIP archive at path for the specified preset, containing only the files that have changed since the last patch. Note: patches is an optional override of the set of patches defined in the export preset. When empty the patches defined in the export preset will be used instead.

public Reckfell.Collections.Dictionary FindExportTemplate(string templateFileName);

Locates export template for the platform, and returns Reckfell.Collections.Dictionary with the following keys: path: String and error: String. This method is provided for convenience and custom export platforms aren't required to use it or keep export templates stored in the same way official templates are.

public string[] GenExportFlags(EditorExportPlatform.DebugFlags flags);

Generates array of command line arguments for the default export templates for the debug flags and editor settings.

public Reckfell.Collections.Array GetCurrentPresets();

Returns array of EditorExportPresets for this platform.

public static string[] GetForcedExportFiles();

Returns array of core file names that always should be exported regardless of preset config.

public static string[] GetForcedExportFiles(EditorExportPreset preset = null);

Returns array of core file names that always should be exported regardless of preset config.

public Reckfell.Collections.Dictionary GetInternalExportFiles(EditorExportPreset preset, bool debug);

Returns additional files that should always be exported regardless of preset configuration, and are not part of the project source. The returned Reckfell.Collections.Dictionary contains filename keys (string) and their corresponding raw data (byte[]).

public string GetMessageCategory(int index);

Returns the message category for the message with the given index.

public int GetMessageCount();

Returns the number of messages in the export log.

public string GetMessageText(int index);

Returns the text for the message with the given index.

public EditorExportPlatform.ExportMessageType GetMessageType(int index);

Returns the type for the message with the given index.

public string GetOsName();

Returns the name of the export operating system handled by this EditorExportPlatform class, as a friendly string. Possible return values are Windows, Linux, macOS, Android, iOS, and Web.

public EditorExportPlatform.ExportMessageType GetWorstMessageType();

Returns most severe message type currently present in the export log.

public Reckfell.Collections.Dictionary SavePack(EditorExportPreset preset, bool debug, string path, bool embed = false);

Saves PCK archive and returns Reckfell.Collections.Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String). If embed is true, PCK content is appended to the end of path file and return Reckfell.Collections.Dictionary additionally include following keys: embedded_start: int (embedded PCK offset) and embedded_size: int (embedded PCK size).

public Reckfell.Collections.Dictionary SavePackPatch(EditorExportPreset preset, bool debug, string path);

Saves patch PCK archive and returns Reckfell.Collections.Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Reckfell.Collections.Dictionary SaveZip(EditorExportPreset preset, bool debug, string path);

Saves ZIP archive and returns Reckfell.Collections.Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Reckfell.Collections.Dictionary SaveZipPatch(EditorExportPreset preset, bool debug, string path);

Saves patch ZIP archive and returns Reckfell.Collections.Dictionary with the following keys: result: Error, so_files: Array (array of the shared/static objects which contains dictionaries with the following keys: path: String, tags: PackedStringArray, and target_folder: String).

public Error SshPushToRemote(string host, string port, ReadOnlySpan<string> scpArgs, string srcFile, string dstFile);

Uploads specified file over SCP protocol to the remote host.

public Error SshPushToRemote(string host, string port, string[] scpArgs, string srcFile, string dstFile);

Uploads specified file over SCP protocol to the remote host.

public Error SshRunOnRemote(string host, string port, ReadOnlySpan<string> sshArg, string cmdArgs, Reckfell.Collections.Array output, int portFwd);

Executes specified command on the remote host via SSH protocol and returns command output in the output.

public Error SshRunOnRemote(string host, string port, string[] sshArg, string cmdArgs, Reckfell.Collections.Array output = null, int portFwd = -1);

Executes specified command on the remote host via SSH protocol and returns command output in the output.

public long SshRunOnRemoteNoWait(string host, string port, ReadOnlySpan<string> sshArgs, string cmdArgs, int portFwd);

Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.

public long SshRunOnRemoteNoWait(string host, string port, string[] sshArgs, string cmdArgs, int portFwd = -1);

Executes specified command on the remote host via SSH protocol and returns process ID (on the remote host) without waiting for command to finish.