Class EditorExportPreset

Export preset configuration.

Inheritance

RefCounted

Object

EditorExportPreset

Remarks

Export preset configuration. Instances of EditorExportPreset by editor UI and intended to be used a read-only configuration passed to the EditorExportPlatform methods when exporting the project.

Methods

are_advanced_options_enabled

Qualifiers: const

Returns true if "Advanced" toggle is enabled in the export dialog.

bool are_advanced_options_enabled

get_custom_features

Qualifiers: const

Returns string with a comma separated list of custom features.

String get_custom_features

get_customized_files

Qualifiers: const

Returns Dictionary of files selected in the "Resources" tab of the export dialog. Dictionary keys are file names and values are export mode - "strip", "keep", or "remove". See also EditorExportPreset.get_file_export_mode.

Dictionary get_customized_files

get_customized_files_count

Qualifiers: const

Returns number of files selected in the "Resources" tab of the export dialog.

int get_customized_files_count

get_encrypt_directory

Qualifiers: const

Returns true, PCK directory encryption is enabled in the export dialog.

bool get_encrypt_directory

get_encrypt_pck

Qualifiers: const

Returns true, PCK encryption is enabled in the export dialog.

bool get_encrypt_pck

get_encryption_ex_filter

Qualifiers: const

Returns file filters to exclude during PCK encryption.

String get_encryption_ex_filter

get_encryption_in_filter

Qualifiers: const

Returns file filters to include during PCK encryption.

String get_encryption_in_filter

get_encryption_key

Qualifiers: const

Returns PCK encryption key.

String get_encryption_key

get_exclude_filter

Qualifiers: const

Returns file filters to exclude during export.

String get_exclude_filter

get_export_filter

Qualifiers: const

Returns export file filter mode selected in the "Resources" tab of the export dialog.

int get_export_filter

get_export_path

Qualifiers: const

Returns export target path.

String get_export_path

get_file_export_mode(String, int)

Qualifiers: const

Returns file export mode for the specified file.

int get_file_export_mode(String path, int default)

Parameters

path String

default int

get_files_to_export

Qualifiers: const

Returns array of files to export.

PackedStringArray get_files_to_export

get_include_filter

Qualifiers: const

Returns file filters to include during export.

String get_include_filter

get_or_env(StringName, String)

Qualifiers: const

Returns export option value or value of environment variable if it is set.

Variant get_or_env(StringName name, String env_var)

Parameters

name StringName

env_var String

get_patches

Qualifiers: const

Returns the list of packs on which to base a patch export on.

PackedStringArray get_patches

get_preset_name

Qualifiers: const

Returns export preset name.

String get_preset_name

get_script_export_mode

Qualifiers: const

Returns script export mode.

int get_script_export_mode

get_version(StringName, bool)

Qualifiers: const

Returns the preset's version number, or fall back to the 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.

String get_version(StringName name, bool windows_version)

Parameters

name StringName

windows_version bool

has(StringName)

Qualifiers: const

Returns true if preset has specified property.

bool has(StringName property)

Parameters

property StringName

has_export_file(String)

Returns true if specified file is exported.

bool has_export_file(String path)

Parameters

path String

is_dedicated_server

Qualifiers: const

Returns true if dedicated server export mode is selected in the export dialog.

bool is_dedicated_server

is_runnable

Qualifiers: const

Returns true if "Runnable" toggle is enabled in the export dialog.

bool is_runnable