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...
EditorExportPlatformExtension
Eredita: EditorExportPlatform < RefCounted < Object
Classe base per implementazioni di EditorExportPlatform personalizzate (estensioni).
Descrizione
Implementazioni esterne di EditorExportPlatform dovrebbero ereditare da questa classe.
Per utilizzare EditorExportPlatform, registrarlo prima attraverso il metodo EditorPlugin.add_export_platform().
Metodi
Descrizioni dei metodi
bool _can_export(preset: EditorExportPreset, debug: bool) virtual const 🔗
Returns true if the specified preset is valid and can be exported. Use set_config_error() and set_config_missing_templates() to set error details.
Usual implementations call _has_valid_export_configuration() and _has_valid_project_configuration() to determine if exporting is possible.
void _cleanup() virtual 🔗
Chiamato dall'editor prima che la registrazione della piattaforma venga annullata.
Error _export_pack(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivio PCK nel percorso path per la preimpostazione preset.
Questo metodo viene chiamato quando si preme il pulsante "Esporta PCK/ZIP" nella finestra di dialogo di esportazione, con "Esporta come patch" disabilitato e PCK selezionato come tipo di file.
Error _export_pack_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivio PCK di patch nel percorso path per la preimpostazione preset, contenente solo i file che sono stati modificati dall'ultima patch.
Questo metodo viene chiamato quando si preme il pulsante "Esporta PCK/ZIP" nella finestra di dialogo di esportazione, con "Esporta come patch" abilitato e PCK selezionato come tipo di file.
Nota: Le patch fornite in patches sono già state caricate quando questo metodo viene chiamato e sono semplicemente fornite come contesto. Quando è vuoto, sono state caricate invece le patch definite nella preimpostazione d'esportazione.
Error _export_project(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual required 🔗
Crea un progetto completo nel percorso path per la preimpostazione preset.
Questo metodo viene chiamato quando si preme il pulsante "Esporta" nella finestra di dialogo di esportazione.
Questa implementazione del metodo può chiamare EditorExportPlatform.save_pack() o EditorExportPlatform.save_zip() per utilizzare il processo di esportazione PCK/ZIP predefinito, oppure chiamare EditorExportPlatform.export_project_files() e implementare un callback personalizzato per elaborare ciascun file esportato.
Error _export_zip(preset: EditorExportPreset, debug: bool, path: String, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivio ZIP nel percorso path per la preimpostazione preset.
Questo metodo viene chiamato quando si preme il pulsante "Esporta PCK/ZIP" nella finestra di dialogo di esportazione, con "Esporta come patch" disabilitato e ZIP selezionato come tipo di file.
Error _export_zip_patch(preset: EditorExportPreset, debug: bool, path: String, patches: PackedStringArray, flags: BitField[DebugFlags]) virtual 🔗
Crea un archivio ZIP nel percorso path per la preimpostazione preset, contenente solo i file che sono stati modificati dall'ultima patch.
Questo metodo viene chiamato quando si preme il pulsante "Esporta PCK/ZIP" nella finestra di dialogo di esportazione, con "Esporta come patch" abilitato e ZIP selezionato come tipo di file.
Nota: Le patch fornite in patches sono già state caricate quando questo metodo viene chiamato e sono semplicemente fornite come contesto. Quando è vuoto, sono state caricate invece le patch definite nella preimpostazione d'esportazione.
PackedStringArray _get_binary_extensions(preset: EditorExportPreset) virtual required const 🔗
Restituisce un array di estensioni binarie supportate per l'esportazione completa del progetto.
String _get_debug_protocol() virtual const 🔗
Restituisce il protocollo utilizzato per il debug remoto. L'implementazione predefinita restituisce tcp://.
String _get_device_architecture(device: int) virtual const 🔗
Restituisce l'architettura del dispositivo per la distribuzione con un clic.
bool _get_export_option_visibility(preset: EditorExportPreset, option: String) virtual const 🔗
Convalida l'opzione option e restituisce la visibilità per la preimpostazione preset. L'implementazione predefinita restituisce true per tutte le opzioni.
String _get_export_option_warning(preset: EditorExportPreset, option: StringName) virtual const 🔗
Convalida l'opzione option e restituisce un messaggio d'avviso per la preimpostazione preset. L'implementazione predefinita restituisce una stringa vuota per tutte le opzioni.
Array[Dictionary] _get_export_options() virtual const 🔗
Restituisce una lista di proprietà, come un Array di dizionari. Ogni Dictionary deve contenere almeno le voci name: StringName e type: Variant.Type.
Inoltre, sono supportate le seguenti chiavi:
hint: PropertyHinthint_string: Stringusage: PropertyUsageFlagsclass_name: StringNamedefault_value: Variant, valore predefinito della proprietà.update_visibility: bool, se impostato sutrue, viene chiamato _get_export_option_visibility() per ogni proprietà quando questa proprietà viene modificata.required: bool, se impostato sutrue, gli avvisi di questa proprietà sono critici e devono essere risolti per rendere possibile l'esportazione. Questo valore è un indicazione per l'implementazione di _has_valid_export_configuration() e non viene utilizzato direttamente dal motore.
Vedi anche Object._get_property_list().
Texture2D _get_logo() virtual required const 🔗
Restituisce il logo della piattaforma visualizzato nella finestra di dialogo di esportazione. Il logo dovrebbe essere 32×32 pixel, adattato alla scala attuale dell'editor (vedi EditorInterface.get_editor_scale()).
String _get_name() virtual required const 🔗
Restituisce il nome della piattaforma d'esportazione.
Texture2D _get_option_icon(device: int) virtual const 🔗
Restituisce l'icona della voce per il dispositivo device nel menu di distribuzione con un clic. L'icona dovrebbe essere 16×16 pixel, adattata alla scala attuale dell'editor (vedi EditorInterface.get_editor_scale()).
String _get_option_label(device: int) virtual const 🔗
Restituisce l'etichetta della voce nel menu di distribuzione con un clic per il dispositivo device.
String _get_option_tooltip(device: int) virtual const 🔗
Restituisce il suggerimento della voce nel menu di distribuzione con un clic per il dispositivo device.
int _get_options_count() virtual const 🔗
Restituisce il numero di dispositivi (o altre opzioni) disponibili nel menu di distribuzione con un clic.
String _get_options_tooltip() virtual const 🔗
Restituisce il suggerimento del pulsante del menu di distribuzione con un clic.
String _get_os_name() virtual required const 🔗
Restituisce il nome dell'OS di destinazione.
PackedStringArray _get_platform_features() virtual required const 🔗
Restituisce un array di funzionalità specifiche della piattaforma.
PackedStringArray _get_preset_features(preset: EditorExportPreset) virtual required const 🔗
Restituisce un array di funzionalità specifiche della piattaforma per il preset specificato.
Texture2D _get_run_icon() virtual const 🔗
Restituisce l'icona per il menu di distribuzione con un clic. L'icona dovrebbe essere 16×16, adattata alla scala attuale dell'editor (vedi EditorInterface.get_editor_scale()).
bool _has_valid_export_configuration(preset: EditorExportPreset, debug: bool) virtual required const 🔗
Restituisce true se la configurazione d'esportazione è valida.
bool _has_valid_project_configuration(preset: EditorExportPreset) virtual required const 🔗
Restituisce true se la configurazione del progetto è valida.
void _initialize() virtual 🔗
Initializes the plugin. Called by the editor when platform is registered.
bool _is_executable(path: String) virtual const 🔗
Restituisce true se il file specificato è un eseguibile valido (eseguibile nativo o script) per la piattaforma di destinazione.
Restituisce true se le opzioni di distribuzione con un clic sono cambiate e l'interfaccia dell'editor si dovrebbe aggiornare.
Error _run(preset: EditorExportPreset, device: int, debug_flags: BitField[DebugFlags]) virtual 🔗
Questo metodo viene chiamato quando viene selezionata l'opzione per il dispositivo device nel menu di distribuzione con un clic.
L'implementazione dovrebbe esportare il progetto in una posizione temporanea, caricarlo ed eseguirlo sul dispositivo device oppure eseguire un'altra azione associata alla voce del menu.
bool _should_update_export_options() virtual 🔗
Restituisce true se la lista delle opzioni di esportazione è cambiata e le preimpostazioni si dovrebbero aggiornare.
String get_config_error() const 🔗
Restituisce il testo del messaggio di errore di configurazione attuale. Questo metodo dovrebbe essere chiamato solo dalle implementazioni di _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
bool get_config_missing_templates() const 🔗
Restituisce true se i modelli di esportazione mancano dalla configurazione attuale. Questo metodo dovrebbe essere chiamato solo dalle implementazioni di _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
void set_config_error(error_text: String) const 🔗
Imposta il testo del messaggio di errore della configurazione attuale. Questo metodo dovrebbe essere chiamato solo dalle implementazioni di _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().
void set_config_missing_templates(missing_templates: bool) const 🔗
Impostato su true se mancano modelli di esportazione dalla configurazione attuale. Questo metodo dovrebbe essere chiamato solo dalle implementazioni di _can_export(), _has_valid_export_configuration() o _has_valid_project_configuration().