:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/EditorExportPreset.xml. .. _class_EditorExportPreset: EditorExportPreset ================== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` Export preset configuration. .. rst-class:: classref-introduction-group Description ----------- Export preset configuration. Instances of **EditorExportPreset** by editor UI and intended to be used a read-only configuration passed to the :ref:`EditorExportPlatform` methods when exporting the project. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`are_advanced_options_enabled`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_custom_features`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`get_customized_files`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_customized_files_count`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_encrypt_directory`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_encrypt_pck`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_encryption_ex_filter`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_encryption_in_filter`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_encryption_key`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_exclude_filter`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ExportFilter` | :ref:`get_export_filter`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_export_path`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`FileExportMode` | :ref:`get_file_export_mode`\ (\ path\: :ref:`String`, default\: :ref:`FileExportMode` = 0\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_files_to_export`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_include_filter`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_or_env`\ (\ name\: :ref:`StringName`, env_var\: :ref:`String`\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_patches`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_preset_name`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_project_setting`\ (\ name\: :ref:`StringName`\ ) | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_script_export_mode`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_version`\ (\ name\: :ref:`StringName`, windows_version\: :ref:`bool`\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has`\ (\ property\: :ref:`StringName`\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_export_file`\ (\ path\: :ref:`String`\ ) | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_dedicated_server`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_runnable`\ (\ ) |const| | +---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_EditorExportPreset_ExportFilter: .. rst-class:: classref-enumeration enum **ExportFilter**: :ref:`🔗` .. _class_EditorExportPreset_constant_EXPORT_ALL_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`ExportFilter` **EXPORT_ALL_RESOURCES** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_EXPORT_SELECTED_SCENES: .. rst-class:: classref-enumeration-constant :ref:`ExportFilter` **EXPORT_SELECTED_SCENES** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_EXPORT_SELECTED_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`ExportFilter` **EXPORT_SELECTED_RESOURCES** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_EXCLUDE_SELECTED_RESOURCES: .. rst-class:: classref-enumeration-constant :ref:`ExportFilter` **EXCLUDE_SELECTED_RESOURCES** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_EXPORT_CUSTOMIZED: .. rst-class:: classref-enumeration-constant :ref:`ExportFilter` **EXPORT_CUSTOMIZED** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_EditorExportPreset_FileExportMode: .. rst-class:: classref-enumeration enum **FileExportMode**: :ref:`🔗` .. _class_EditorExportPreset_constant_MODE_FILE_NOT_CUSTOMIZED: .. rst-class:: classref-enumeration-constant :ref:`FileExportMode` **MODE_FILE_NOT_CUSTOMIZED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_MODE_FILE_STRIP: .. rst-class:: classref-enumeration-constant :ref:`FileExportMode` **MODE_FILE_STRIP** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_MODE_FILE_KEEP: .. rst-class:: classref-enumeration-constant :ref:`FileExportMode` **MODE_FILE_KEEP** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_MODE_FILE_REMOVE: .. rst-class:: classref-enumeration-constant :ref:`FileExportMode` **MODE_FILE_REMOVE** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_EditorExportPreset_ScriptExportMode: .. rst-class:: classref-enumeration enum **ScriptExportMode**: :ref:`🔗` .. _class_EditorExportPreset_constant_MODE_SCRIPT_TEXT: .. rst-class:: classref-enumeration-constant :ref:`ScriptExportMode` **MODE_SCRIPT_TEXT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_MODE_SCRIPT_BINARY_TOKENS: .. rst-class:: classref-enumeration-constant :ref:`ScriptExportMode` **MODE_SCRIPT_BINARY_TOKENS** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_EditorExportPreset_constant_MODE_SCRIPT_BINARY_TOKENS_COMPRESSED: .. rst-class:: classref-enumeration-constant :ref:`ScriptExportMode` **MODE_SCRIPT_BINARY_TOKENS_COMPRESSED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_EditorExportPreset_method_are_advanced_options_enabled: .. rst-class:: classref-method :ref:`bool` **are_advanced_options_enabled**\ (\ ) |const| :ref:`🔗` Returns ``true`` if "Advanced" toggle is enabled in the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_custom_features: .. rst-class:: classref-method :ref:`String` **get_custom_features**\ (\ ) |const| :ref:`🔗` Returns string with a comma separated list of custom features. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_customized_files: .. rst-class:: classref-method :ref:`Dictionary` **get_customized_files**\ (\ ) |const| :ref:`🔗` Returns :ref:`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 :ref:`get_file_export_mode()`. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_customized_files_count: .. rst-class:: classref-method :ref:`int` **get_customized_files_count**\ (\ ) |const| :ref:`🔗` Returns number of files selected in the "Resources" tab of the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encrypt_directory: .. rst-class:: classref-method :ref:`bool` **get_encrypt_directory**\ (\ ) |const| :ref:`🔗` Returns ``true`` if PCK directory encryption is enabled in the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encrypt_pck: .. rst-class:: classref-method :ref:`bool` **get_encrypt_pck**\ (\ ) |const| :ref:`🔗` Returns ``true`` if PCK encryption is enabled in the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_ex_filter: .. rst-class:: classref-method :ref:`String` **get_encryption_ex_filter**\ (\ ) |const| :ref:`🔗` Returns file filters to exclude during PCK encryption. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_in_filter: .. rst-class:: classref-method :ref:`String` **get_encryption_in_filter**\ (\ ) |const| :ref:`🔗` Returns file filters to include during PCK encryption. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_key: .. rst-class:: classref-method :ref:`String` **get_encryption_key**\ (\ ) |const| :ref:`🔗` Returns PCK encryption key. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_exclude_filter: .. rst-class:: classref-method :ref:`String` **get_exclude_filter**\ (\ ) |const| :ref:`🔗` Returns file filters to exclude during export. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_export_filter: .. rst-class:: classref-method :ref:`ExportFilter` **get_export_filter**\ (\ ) |const| :ref:`🔗` Returns export file filter mode selected in the "Resources" tab of the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_export_path: .. rst-class:: classref-method :ref:`String` **get_export_path**\ (\ ) |const| :ref:`🔗` Returns export target path. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_file_export_mode: .. rst-class:: classref-method :ref:`FileExportMode` **get_file_export_mode**\ (\ path\: :ref:`String`, default\: :ref:`FileExportMode` = 0\ ) |const| :ref:`🔗` Returns file export mode for the specified file. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_files_to_export: .. rst-class:: classref-method :ref:`PackedStringArray` **get_files_to_export**\ (\ ) |const| :ref:`🔗` Returns array of files to export. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_include_filter: .. rst-class:: classref-method :ref:`String` **get_include_filter**\ (\ ) |const| :ref:`🔗` Returns file filters to include during export. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_or_env: .. rst-class:: classref-method :ref:`Variant` **get_or_env**\ (\ name\: :ref:`StringName`, env_var\: :ref:`String`\ ) |const| :ref:`🔗` Returns export option value or value of environment variable if it is set. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_patches: .. rst-class:: classref-method :ref:`PackedStringArray` **get_patches**\ (\ ) |const| :ref:`🔗` Returns the list of packs on which to base a patch export on. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_preset_name: .. rst-class:: classref-method :ref:`String` **get_preset_name**\ (\ ) |const| :ref:`🔗` Returns export preset name. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_project_setting: .. rst-class:: classref-method :ref:`Variant` **get_project_setting**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` Returns the value of the setting identified by ``name`` using export preset feature tag overrides instead of current OS features. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_script_export_mode: .. rst-class:: classref-method :ref:`int` **get_script_export_mode**\ (\ ) |const| :ref:`🔗` Returns script export mode. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_version: .. rst-class:: classref-method :ref:`String` **get_version**\ (\ name\: :ref:`StringName`, windows_version\: :ref:`bool`\ ) |const| :ref:`🔗` Returns the preset's version number, or fall back to the :ref:`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. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_has: .. rst-class:: classref-method :ref:`bool` **has**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns ``true`` if the preset has the property named ``property``. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_has_export_file: .. rst-class:: classref-method :ref:`bool` **has_export_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` Returns ``true`` if specified file is exported. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_is_dedicated_server: .. rst-class:: classref-method :ref:`bool` **is_dedicated_server**\ (\ ) |const| :ref:`🔗` Returns ``true`` if dedicated server export mode is selected in the export dialog. .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_is_runnable: .. rst-class:: classref-method :ref:`bool` **is_runnable**\ (\ ) |const| :ref:`🔗` Returns ``true`` if "Runnable" toggle is enabled in the export dialog. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`