Class reference
EditorExportPreset
Inherits RefCounted
Export preset configuration.
Description
Represents the configuration of an export preset, as created by the editor's export dialog. An EditorExportPreset instance is intended to be used a read-only configuration passed to the EditorExportPlatform methods when exporting the project.
Methods
bool are_advanced_options_enabled() const
bool are_advanced_options_enabled() constReturns true if the "Advanced" toggle is enabled in the export dialog.
String get_custom_features() const
String get_custom_features() constReturns a comma-separated list of custom features added to this preset, as a string. See Feature tags in the documentation for more information.
Dictionary get_customized_files() const
Dictionary get_customized_files() constReturns a dictionary of files selected in the "Resources" tab of the export dialog. The dictionary's keys are file paths, and its values are the corresponding export modes: "strip", "keep", or "remove". See also get_file_export_mode().
int get_customized_files_count() const
int get_customized_files_count() constReturns the number of files selected in the "Resources" tab of the export dialog.
bool get_encrypt_directory() const
bool get_encrypt_directory() constReturns true if PCK directory encryption is enabled in the export dialog.
bool get_encrypt_pck() const
bool get_encrypt_pck() constReturns true if PCK encryption is enabled in the export dialog.
String get_encryption_ex_filter() const
String get_encryption_ex_filter() constReturns file filters to exclude during PCK encryption.
String get_encryption_in_filter() const
String get_encryption_in_filter() constReturns file filters to include during PCK encryption.
String get_encryption_key() const
String get_encryption_key() constReturns PCK encryption key.
String get_exclude_filter() const
String get_exclude_filter() constReturns file filters to exclude during export.
int get_export_filter() const
int get_export_filter() constReturns export file filter mode selected in the "Resources" tab of the export dialog.
String get_export_path() const
String get_export_path() constReturns export target path.
int get_file_export_mode(String path, int default = 0) const
int get_file_export_mode(String path, int default = 0) constReturns file export mode for the specified file.
PackedStringArray get_files_to_export() const
PackedStringArray get_files_to_export() constReturns array of files to export.
String get_include_filter() const
String get_include_filter() constReturns file filters to include during export.
Variant get_or_env(StringName name, String env_var) const
Variant get_or_env(StringName name, String env_var) constReturns export option value or value of environment variable if it is set.
PackedStringArray get_patches() const
PackedStringArray get_patches() constReturns the list of packs on which to base a patch export on.
String get_preset_name() const
String get_preset_name() constReturns this export preset's name.
Variant get_project_setting(StringName name)
Variant get_project_setting(StringName name)Returns the value of the setting identified by name using export preset feature tag overrides instead of current OS features.
int get_script_export_mode() const
int get_script_export_mode() constReturns the export mode used by GDScript files. 0 for "Text", 1 for "Binary tokens", and 2 for "Compressed binary tokens (smaller files)".
String get_version(StringName name, bool windows_version) const
String get_version(StringName name, bool windows_version) constReturns the preset's version number, or fall back to the ProjectSettings.application/config/version project setting if set to an empty string. If windows_version is true, formats the returned version number to be compatible with Windows executable metadata.
bool has(StringName property) const
bool has(StringName property) constReturns true if the preset has the property named property.
bool has_export_file(String path)
bool has_export_file(String path)Returns true if the file at the specified path will be exported.
bool is_dedicated_server() const
bool is_dedicated_server() constReturns true if the dedicated server export mode is selected in the export dialog.
bool is_runnable() const
bool is_runnable() constReturns true if the "Runnable" toggle is enabled in the export dialog.