Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
EditorExportPlatform
Eredita: RefCounted < Object
Ereditato da: EditorExportPlatformAndroid, EditorExportPlatformAppleEmbedded, EditorExportPlatformExtension, EditorExportPlatformMacOS, EditorExportPlatformPC, EditorExportPlatformWeb
Identifica una piattaforma di esportazione supportata e fornisce internamente la funzionalità di esportazione verso tale piattaforma.
Descrizione
Risorsa base che fornisce la funzionalità di esportazione di una build di rilascio di un progetto su una piattaforma, dall'editor. Memorizza metadati specifici della piattaforma, come il nome e le funzionalità supportate della piattaforma, ed esegue l'esportazione dei progetti, dei file PCK e dei file ZIP. Utilizza un modello d'esportazione per la piattaforma fornito al momento dell'esportazione del progetto.
Utilizzato in scripting da EditorExportPlugin per configurare la personalizzazione specifica per una piattaforma di scene e di risorse. Consulta EditorExportPlugin._begin_customize_scenes() e EditorExportPlugin._begin_customize_resources() per ulteriori dettagli.
Metodi
Enumerazioni
enum ExportMessageType: 🔗
ExportMessageType EXPORT_MESSAGE_NONE = 0
Tipo di messaggio non valido utilizzato come valore predefinito quando nessun tipo viene specificato.
ExportMessageType EXPORT_MESSAGE_INFO = 1
Tipo di messaggio per i messaggi informativi che non hanno alcun effetto sull'esportazione.
ExportMessageType EXPORT_MESSAGE_WARNING = 2
Tipo di messaggio per i messaggi di avviso che dovrebbero essere gestiti ma che consentono comunque di completare l'esportazione.
ExportMessageType EXPORT_MESSAGE_ERROR = 3
Tipo di messaggio per i messaggi di errore che devono essere risolti e che impediscono l'esportazione.
flags DebugFlags: 🔗
DebugFlags DEBUG_FLAG_DUMB_CLIENT = 1
Il flag è impostato se si prevede che il progetto sottoposto a debug remoto utilizzi un file system remoto. Se impostato, gen_export_flags() aggiungerà gli argomenti della riga di comando --remote-fs e --remote-fs-password (se EditorSettings.filesystem/file_server/password è impostato) alla lista restituita.
DebugFlags DEBUG_FLAG_REMOTE_DEBUG = 2
Il flag è impostato se il debug remoto è abilitato. Se impostato, gen_export_flags() aggiungerà gli argomenti della riga di comando --remote-debug e --breakpoints (se i punti d'interruzione sono selezionati nell'editor di script o aggiunti dall'estensione) alla lista restituita.
DebugFlags DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST = 4
Il flag è impostato se il progetto sottoposto a debug remoto è in esecuzione sul localhost. Se impostato, gen_export_flags() utilizzerà localhost invece di EditorSettings.network/debug/remote_host come host del debugger remoto.
DebugFlags DEBUG_FLAG_VIEW_COLLISIONS = 8
Il flag è impostato se l'opzione di debug remoto "Forme di collisione visibili" è abilitata. Se impostato, gen_export_flags() aggiungerà l'argomento della riga di comando --debug-collisions alla lista restituita.
Il flag è impostato se l'opzione di debug remoto "Navigazione visibile" è abilitata. Se impostato, gen_export_flags() aggiungerà l'argomento della riga di comando --debug-navigation alla lista restituita.
Descrizioni dei metodi
void add_message(type: ExportMessageType, category: String, message: String) 🔗
Aggiunge un messaggio al log d'esportazione che sarà visualizzato al termine dell'esportazione.
void clear_messages() 🔗
Cancella il log d'esportazione.
EditorExportPreset create_preset() 🔗
Crea una nuova preimpostazione per questa piattaforma.
Error export_pack(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0) 🔗
Crea un archivio PCK nel percorso path per la preimpostazione preset.
Error export_pack_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray = PackedStringArray(), flags: BitField[DebugFlags] = 0) 🔗
Crea un archivio PCK di patch nel percorso path per la preimpostazione preset, contenente solo i file che sono stati modificati dall'ultima patch.
Nota: patches è una sostituzione facoltativa dell'insieme di patch definite nella preimpostazione d'esportazione. Quando è vuoto, saranno invece utilizzate le patch definite nella preimpostazione d'esportazione.
Error export_project(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0, notify: bool = true) 🔗
Creates a full project at path for the specified preset. If notify is true, plugins using EditorExportPlugin._export_begin() will be called during the process.
Error export_project_files(preset: EditorExportPreset, debug: bool, save_cb: Callable, shared_cb: Callable = Callable()) 🔗
Esporta file di progetto per la preimpostazione specificata. Questo metodo può essere utilizzato per implementare un formato di esportazione personalizzato, diverso da PCK e ZIP. Uno dei callback viene chiamato per ogni file esportato.
save_cb viene chiamato per tutti i file esportati e ha i seguenti argomenti: 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 viene chiamato per le librerie native condivise/statiche esportate e ha i seguenti argomenti: file_path: String, tags: PackedStringArray, target_folder: String.
Nota: file_index e file_count sono pensati solo per monitorare il progresso e non sono necessariamente univoci e precisi.
Error export_zip(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags] = 0) 🔗
Crea un archivio ZIP nel percorso path per la preimpostazione preset.
Error export_zip_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray = PackedStringArray(), flags: BitField[DebugFlags] = 0) 🔗
Crea un archivio ZIP di patch nel percorso path per la preimpostazione preset, contenente solo i file che sono stati modificati dall'ultima patch.
Nota: patches è una sostituzione facoltativa dell'insieme di patch definite nella preimpostazione di esportazione. Quando è vuoto, saranno invece utilizzate le patch definite nella preimpostazione d'esportazione.
Dictionary find_export_template(template_file_name: String) const 🔗
Individua il modello di esportazione per la piattaforma e restituisce Dictionary con le seguenti chiavi: path: String e error: String. Questo metodo è fornito per comodità e le piattaforme di esportazione personalizzate non sono costrette a utilizzarlo o a memorizzare i modelli di esportazione nello stesso modo dei modelli ufficiali.
PackedStringArray gen_export_flags(flags: BitField[DebugFlags]) 🔗
Genera un'array di argomenti della riga di comando per i modelli di esportazione predefiniti per i flag di debug e le impostazioni dell'editor.
Array get_current_presets() const 🔗
Restituisce un array di EditorExportPreset per questa piattaforma.
PackedStringArray get_forced_export_files(preset: EditorExportPreset = null) static 🔗
Restituisce un array di nomi di file essenziali che dovrebbero sempre essere esportati, a prescindere dalla configurazione della preimpostazione.
Dictionary get_internal_export_files(preset: EditorExportPreset, debug: bool) 🔗
Restituisce file aggiuntivi che devono sempre essere esportati a prescindere dalla configurazione della preimpostazione e che non fanno parte della sorgente del progetto. Il Dictionary restituito contiene chiavi dei nomi dei file (String) e i dati grezzi corrispondenti (PackedByteArray).
String get_message_category(index: int) const 🔗
Returns the message category for the message with the given index.
int get_message_count() const 🔗
Returns the number of messages in the export log.
String get_message_text(index: int) const 🔗
Returns the text for the message with the given index.
ExportMessageType get_message_type(index: int) const 🔗
Returns the type for the message with the given index.
Restituisce il nome del sistema operativo di esportazione gestito da questa classe EditorExportPlatform, come stringa leggibile in chiaro. I possibili valori restituiti sono Windows, Linux, macOS, Android, iOS e Web.
ExportMessageType get_worst_message_type() const 🔗
Restituisce il tipo di messaggio più severo attualmente presente nel log d'esportazione.
Dictionary save_pack(preset: EditorExportPreset, debug: bool, path: String, embed: bool = false) 🔗
Salva un archivio PCK e restituisce un Dictionary con le seguenti chiavi: result: Error, so_files: Array (array degli oggetti condivisi/statici che contiene dizionari con le seguenti chiavi: path: String, tags: PackedStringArray e target_folder: String).
Se embed è true, il contenuto del PCK viene aggiunto alla fine del file nel percorso path e restituisce un Dictionary che include inoltre le seguenti chiavi: embedded_start: int (offset del PCK incorporato) e embedded_size: int (dimensione del PCK incorporato).
Dictionary save_pack_patch(preset: EditorExportPreset, debug: bool, path: String) 🔗
Salva un archivio PCK di patch e restituisce un Dictionary con le seguenti chiavi: result: Error, so_files: Array (array degli oggetti condivisi/statici che contiene dizionari con le seguenti chiavi: path: String, tags: PackedStringArray e target_folder: String).
Dictionary save_zip(preset: EditorExportPreset, debug: bool, path: String) 🔗
Salva un archivio ZIP e restituisce un Dictionary con le seguenti chiavi: result: Error, so_files: Array (array degli oggetti condivisi/statici che contiene dizionari con le seguenti chiavi: path: String, tags: PackedStringArray e target_folder: String).
Dictionary save_zip_patch(preset: EditorExportPreset, debug: bool, path: String) 🔗
Salva un archivio ZIP di patch e restituisce un Dictionary con le seguenti chiavi: result: Error, so_files: Array (array degli oggetti condivisi/statici che contiene dizionari con le seguenti chiavi: path: String, tags: PackedStringArray e target_folder: String).
Error ssh_push_to_remote(host: String, port: String, scp_args: PackedStringArray, src_file: String, dst_file: String) const 🔗
Carica il file specificato tramite il protocollo SCP sull'host remoto.
Error ssh_run_on_remote(host: String, port: String, ssh_arg: PackedStringArray, cmd_args: String, output: Array = [], port_fwd: int = -1) const 🔗
Esegue il comando specificato tramite il protocollo SSH sull'host remoto e restituisce l'output del comando nel parametro output.
int ssh_run_on_remote_no_wait(host: String, port: String, ssh_args: PackedStringArray, cmd_args: String, port_fwd: int = -1) const 🔗
Esegue il comando specificato tramite il protocollo SSH sull'host remoto e restituisce l'ID del processo (sull'host remoto) senza attendere il completamento del comando.