EditorExportPlatform
Hereda: RefCounted < Object
Heredado por: EditorExportPlatformAndroid, EditorExportPlatformAppleEmbedded, EditorExportPlatformExtension, EditorExportPlatformMacOS, EditorExportPlatformPC, EditorExportPlatformWeb
Identifica una plataforma de exportación compatible e internamente proporciona la funcionalidad de exportar a esa plataforma.
Descripción
Base resource that provides the functionality of exporting a release build of a project to a platform, from the editor. Stores platform-specific metadata such as the name and supported features of the platform, and performs the exporting of projects, PCK files, and ZIP files. Uses an export template for the platform provided at the time of project exporting.
Used in scripting by EditorExportPlugin to configure platform-specific customization of scenes and resources. See EditorExportPlugin._begin_customize_scenes() and EditorExportPlugin._begin_customize_resources() for more details.
Tutoriales
Métodos
Enumeraciones
enum ExportMessageType: 🔗
ExportMessageType EXPORT_MESSAGE_NONE = 0
Tipo de mensaje inválido utilizado como valor por defecto cuando no se especifica un tipo.
ExportMessageType EXPORT_MESSAGE_INFO = 1
Tipo de mensaje para mensajes informativos que no tienen ningún efecto en la exportación.
ExportMessageType EXPORT_MESSAGE_WARNING = 2
Tipo de mensaje para mensajes de advertencia que deben abordarse pero que aún permiten completar la exportación.
ExportMessageType EXPORT_MESSAGE_ERROR = 3
Tipo de mensaje para mensajes de error que deben abordarse y fallan en la exportación.
flags DebugFlags: 🔗
DebugFlags DEBUG_FLAG_DUMB_CLIENT = 1
Flag is set if the remotely debugged project is expected to use the remote file system. If set, gen_export_flags() will append --remote-fs and --remote-fs-password (if EditorSettings.filesystem/file_server/password is defined) command line arguments to the returned list.
DebugFlags DEBUG_FLAG_REMOTE_DEBUG = 2
Flag is set if remote debug is enabled. If set, gen_export_flags() will append --remote-debug and --breakpoints (if breakpoints are selected in the script editor or added by the plugin) command line arguments to the returned list.
DebugFlags DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST = 4
Flag is set if remotely debugged project is running on the localhost. If set, gen_export_flags() will use localhost instead of EditorSettings.network/debug/remote_host as remote debugger host.
DebugFlags DEBUG_FLAG_VIEW_COLLISIONS = 8
Flag is set if the "Visible Collision Shapes" remote debug option is enabled. If set, gen_export_flags() will append the --debug-collisions command line argument to the returned list.
Flag is set if the "Visible Navigation" remote debug option is enabled. If set, gen_export_flags() will append the --debug-navigation command line argument to the returned list.
Descripciones de Métodos
void add_message(type: ExportMessageType, category: String, message: String) 🔗
Agrega un mensaje al registro de exportación que se mostrará cuando finalice la exportación.
void clear_messages() 🔗
Borra el registro de exportación.
EditorExportPreset create_preset() 🔗
Crea un nuevo ajuste preestablecido para esta plataforma.
Error export_pack(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0) 🔗
Crea un archivo PCK en path para el path especificado.
Error export_pack_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray = PackedStringArray(), flags: BitField[DebugFlags] = 0) 🔗
Crea un archivo PCK de parche en path para el preset especificado, que contiene solo los archivos que han cambiado desde el último parche.
Nota: patches es una sobrescritura opcional del conjunto de parches definidos en el preajuste de exportación. Cuando está vacío, se utilizarán los parches definidos en el preajuste de exportación.
Error export_project(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0) 🔗
Crea un proyecto completo en path para el preset especificado.
Error export_project_files(preset: EditorExportPreset, debug: bool, save_cb: Callable, shared_cb: Callable = Callable()) 🔗
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.
Error export_zip(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0) 🔗
Crea un archivo ZIP en path para el preset especificado.
Error export_zip_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray = PackedStringArray(), flags: BitField[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.
Dictionary find_export_template(template_file_name: String) const 🔗
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.
PackedStringArray gen_export_flags(flags: BitField[DebugFlags]) 🔗
Generates array of command line arguments for the default export templates for the debug flags and editor settings.
Array get_current_presets() const 🔗
Returns array of EditorExportPresets for this platform.
PackedStringArray get_forced_export_files(preset: EditorExportPreset = null) static 🔗
Returns array of core file names that always should be exported regardless of preset config.
Dictionary get_internal_export_files(preset: EditorExportPreset, debug: bool) 🔗
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).
String get_message_category(index: int) const 🔗
Devuelve la categoría del mensaje, para el mensaje con index.
int get_message_count() const 🔗
Devuelve el número de mensajes en el registro de exportación.
String get_message_text(index: int) const 🔗
Devuelve el texto del mensaje, para el mensaje con index.
ExportMessageType get_message_type(index: int) const 🔗
Devuelve el tipo de mensaje, para el mensaje con index.
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.
ExportMessageType get_worst_message_type() const 🔗
Returns most severe message type currently present in the export log.
Dictionary save_pack(preset: EditorExportPreset, debug: bool, path: String, embed: bool = false) 🔗
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).
Dictionary save_pack_patch(preset: EditorExportPreset, debug: bool, path: String) 🔗
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).
Dictionary save_zip(preset: EditorExportPreset, debug: bool, path: String) 🔗
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).
Dictionary save_zip_patch(preset: EditorExportPreset, debug: bool, path: String) 🔗
Guarda el archivo ZIP del parche y devuelve un Dictionary con las siguientes claves: result: Error, so_files: Array (array de objetos compartidos/estáticos que contiene diccionarios con las siguientes claves: path: String, tags: PackedStringArray y target_folder: String).
Error ssh_push_to_remote(host: String, port: String, scp_args: PackedStringArray, src_file: String, dst_file: String) const 🔗
Sube el archivo especificado a través del protocolo SCP al host remoto.
Error ssh_run_on_remote(host: String, port: String, ssh_arg: PackedStringArray, cmd_args: String, output: Array = [], port_fwd: int = -1) const 🔗
Ejecuta el comando especificado en el host remoto a través del protocolo SSH y devuelve la salida del comando en output.
int ssh_run_on_remote_no_wait(host: String, port: String, ssh_args: PackedStringArray, cmd_args: String, port_fwd: int = -1) const 🔗
Ejecuta el comando especificado en el host remoto a través del protocolo SSH y devuelve el ID del proceso (en el host remoto) sin esperar a que el comando finalice.