EditorExportPlatform #

func add_message(message: String) -> void#

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

func clear_messages() -> void#

Clears the export log.

func create_preset() -> EditorExportPreset#

Create a new preset for this platform.

func export_pack(flags: int = 0 enumEditorExportPlatform.DebugFlags) -> intError#

Creates a PCK archive at path for the specified preset.

func export_pack_patch(flags: int = 0 enumEditorExportPlatform.DebugFlags) -> intError#

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.

func export_project(flags: int = 0 enumEditorExportPlatform.DebugFlags) -> intError#

Creates a full project at path for the specified preset.

func export_project_files(shared_cb: Callable = Callable()) -> intError#

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: file_path: String, file_data: PackedByteArray, file_index: int, file_count: int, encryption_include_filters: PackedStringArray, encryption_exclude_filters: PackedStringArray, encryption_key: PackedByteArray.

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.

func export_zip(flags: int = 0 enumEditorExportPlatform.DebugFlags) -> intError#

Create a ZIP archive at path for the specified preset.

func export_zip_patch(flags: int = 0 enumEditorExportPlatform.DebugFlags) -> intError#

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.

const func find_export_template(template_file_name: String) -> Dictionary#

Locates export template for the platform, and returns 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.

func gen_export_flags(flags: int enumEditorExportPlatform.DebugFlags) -> PackedStringArray#

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

const func get_current_presets() -> Array#

Returns array of EditorExportPresets for this platform.

static func get_forced_export_files() -> PackedStringArray#

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

func get_internal_export_files(debug: bool) -> Dictionary#

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

const func get_message_category(index: int) -> String#

Returns message category, for the message with index.

const func get_message_count() -> int#

Returns number of messages in the export log.

const func get_message_text(index: int) -> String#

Returns message text, for the message with index.

const func get_message_type(index: int) -> intEditorExportPlatform.ExportMessageType#

Returns message type, for the message with index.

const func get_os_name() -> String#

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.

const func get_worst_message_type() -> intEditorExportPlatform.ExportMessageType#

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

func save_pack(embed: bool = false) -> Dictionary#

Saves PCK archive and returns 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 Dictionary additionally include following keys: embedded_start: int (embedded PCK offset) and embedded_size: int (embedded PCK size).

func save_pack_patch(path: String) -> Dictionary#

Saves patch PCK archive and returns 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).

func save_zip(path: String) -> Dictionary#

Saves ZIP archive and returns 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).

func save_zip_patch(path: String) -> Dictionary#

Saves patch ZIP archive and returns 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).

const func ssh_push_to_remote(dst_file: String) -> intError#

Uploads specified file over SCP protocol to the remote host.

const func ssh_run_on_remote(port_fwd: int = -1) -> intError#

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

const func ssh_run_on_remote_no_wait(port_fwd: int = -1) -> int#

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