Index · Object → RefCounted → EditorExportPreset

EditorExportPreset

Export preset configuration.

Class 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

func are_advanced_options_enabled() -> bool

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

func get_custom_features() -> String

Returns a comma-separated list of custom features added to this preset, as a string. See Feature tags in the documentation for more information.

func get_customized_files() -> Dictionary

Returns 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().

func get_customized_files_count() -> int

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

func get_encrypt_directory() -> bool

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

func get_encrypt_pck() -> bool

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

func get_encryption_ex_filter() -> String

Returns file filters to exclude during PCK encryption.

func get_encryption_in_filter() -> String

Returns file filters to include during PCK encryption.

func get_encryption_key() -> String

Returns PCK encryption key.

func get_exclude_filter() -> String

Returns file filters to exclude during export.

func get_export_filter() -> EditorExportPreset.ExportFilter

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

func get_export_path() -> String

Returns export target path.

func get_file_export_mode(path: String, default: EditorExportPreset.FileExportMode = 0) -> EditorExportPreset.FileExportMode

Returns file export mode for the specified file.

func get_files_to_export() -> PackedStringArray

Returns array of files to export.

func get_include_filter() -> String

Returns file filters to include during export.

func get_or_env(name: StringName, env_var: String) -> Variant

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

func get_patches() -> PackedStringArray

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

func get_preset_name() -> String

Returns this export preset's name.

func get_project_setting(name: StringName) -> Variant

Returns the value of the setting identified by name using export preset feature tag overrides instead of current OS features.

func get_script_export_mode() -> EditorExportPreset.ScriptExportMode

Returns the export mode used by GDScript files. 0 for "Text", 1 for "Binary tokens", and 2 for "Compressed binary tokens (smaller files)".

func get_version(name: StringName, windows_version: bool) -> String

Returns 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.

func has(property: StringName) -> bool

Returns true if the preset has the property named property.

func has_export_file(path: String) -> bool

Returns true if the file at the specified path will be exported.

func is_dedicated_server() -> bool

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

func is_runnable() -> bool

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

Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Object (2)

Enums & Constants

enum ExportFilter
EXPORT_ALL_RESOURCES = 0
EXPORT_SELECTED_SCENES = 1
EXPORT_SELECTED_RESOURCES = 2
EXCLUDE_SELECTED_RESOURCES = 3
EXPORT_CUSTOMIZED = 4
enum FileExportMode
MODE_FILE_NOT_CUSTOMIZED = 0
MODE_FILE_STRIP = 1
MODE_FILE_KEEP = 2
MODE_FILE_REMOVE = 3
enum ScriptExportMode
MODE_SCRIPT_TEXT = 0
MODE_SCRIPT_BINARY_TOKENS = 1
MODE_SCRIPT_BINARY_TOKENS_COMPRESSED = 2