:github_url: hide .. _class_EditorExportPreset: EditorExportPreset ================== **继承：** :ref:`RefCounted` **<** :ref:`Object` 导出预设配置。 .. rst-class:: classref-introduction-group 描述 ---- 表示由编辑器的导出对话框创建的导出预设的配置。\ **EditorExportPreset** 实例旨在用作在导出项目时传递给 :ref:`EditorExportPlatform` 方法的只读配置。 .. rst-class:: classref-reftable-group 方法 ---- .. 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:`ScriptExportMode` | :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 枚举 ---- .. _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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `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 `contributing one `__! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group 方法说明 -------- .. _class_EditorExportPreset_method_are_advanced_options_enabled: .. rst-class:: classref-method :ref:`bool` **are_advanced_options_enabled**\ (\ ) |const| :ref:`🔗` 如果导出对话框中打开了“高级”开关，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_custom_features: .. rst-class:: classref-method :ref:`String` **get_custom_features**\ (\ ) |const| :ref:`🔗` 返回添加至该预设的自定义特性列表，是一个用英文逗号分隔的字符串。详见《\ :doc:`特性标签 <../tutorials/export/feature_tags>`\ 》文档。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_customized_files: .. rst-class:: classref-method :ref:`Dictionary` **get_customized_files**\ (\ ) |const| :ref:`🔗` 返回在导出对话框“资源”选项卡中选中的所有文件，是一个字典。字典的键是文件名，值是对应的导出模式 ：\ ``"strip"``\ 、\ ``"keep"`` 或 ``"remove"``\ 。另见 :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:`🔗` 返回在导出对话框“资源”选项卡中选中的文件数。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encrypt_directory: .. rst-class:: classref-method :ref:`bool` **get_encrypt_directory**\ (\ ) |const| :ref:`🔗` 如果导出对话框中启用了 PCK 目录加密，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encrypt_pck: .. rst-class:: classref-method :ref:`bool` **get_encrypt_pck**\ (\ ) |const| :ref:`🔗` 如果导出对话框中启用了 PCK 加密，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_ex_filter: .. rst-class:: classref-method :ref:`String` **get_encryption_ex_filter**\ (\ ) |const| :ref:`🔗` 返回 PCK 加密时需要排除的文件过滤器。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_in_filter: .. rst-class:: classref-method :ref:`String` **get_encryption_in_filter**\ (\ ) |const| :ref:`🔗` 返回 PCK 加密时需要包含的文件过滤器。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_encryption_key: .. rst-class:: classref-method :ref:`String` **get_encryption_key**\ (\ ) |const| :ref:`🔗` 返回 PCK 加密密钥。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_exclude_filter: .. rst-class:: classref-method :ref:`String` **get_exclude_filter**\ (\ ) |const| :ref:`🔗` 返回导出时需要排除的文件过滤器。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_export_filter: .. rst-class:: classref-method :ref:`ExportFilter` **get_export_filter**\ (\ ) |const| :ref:`🔗` 返回导出对话框“资源”选项卡中选中的导出文件过滤模式。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_export_path: .. rst-class:: classref-method :ref:`String` **get_export_path**\ (\ ) |const| :ref:`🔗` 返回导出目标的路径。 .. 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:`🔗` 返回指定文件的文件导出模式。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_files_to_export: .. rst-class:: classref-method :ref:`PackedStringArray` **get_files_to_export**\ (\ ) |const| :ref:`🔗` 返回要导出的文件数组。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_include_filter: .. rst-class:: classref-method :ref:`String` **get_include_filter**\ (\ ) |const| :ref:`🔗` 返回导出时需要包含的文件过滤器。 .. 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:`🔗` 返回导出选项的值，如果设置了环境变量则返回环境变量的值。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_patches: .. rst-class:: classref-method :ref:`PackedStringArray` **get_patches**\ (\ ) |const| :ref:`🔗` 返回导出补丁时用作基础的包的列表。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_preset_name: .. rst-class:: classref-method :ref:`String` **get_preset_name**\ (\ ) |const| :ref:`🔗` 返回导出预设的名称。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_project_setting: .. rst-class:: classref-method :ref:`Variant` **get_project_setting**\ (\ name\: :ref:`StringName`\ ) :ref:`🔗` 返回名为 ``name`` 的设置项的值，会使用导出预设特性标签覆盖，不使用当前操作系统的特性。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_get_script_export_mode: .. rst-class:: classref-method :ref:`ScriptExportMode` **get_script_export_mode**\ (\ ) |const| :ref:`🔗` 返回 GDScript 文件的导出模式。\ ``0`` 表示“文本”，\ ``1`` 表示“二进制标记”，\ ``2`` 表示“压缩二进制标记（文件较小）”。 .. 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:`🔗` 返回预设的版本号，如果为空字符串则回退至 :ref:`ProjectSettings.application/config/version` 项目设置。 如果 ``windows_version`` 为 ``true``\ ，则会对返回的版本号进行格式化，让其与 Windows 可执行文件元数据兼容。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_has: .. rst-class:: classref-method :ref:`bool` **has**\ (\ property\: :ref:`StringName`\ ) |const| :ref:`🔗` 如果预设中存在名为 ``property`` 的属性，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_has_export_file: .. rst-class:: classref-method :ref:`bool` **has_export_file**\ (\ path\: :ref:`String`\ ) :ref:`🔗` 如果会导出路径为 ``path`` 的文件，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_is_dedicated_server: .. rst-class:: classref-method :ref:`bool` **is_dedicated_server**\ (\ ) |const| :ref:`🔗` 如果导出对话框中选择了专用服务器导出模式，则返回 ``true``\ 。 .. rst-class:: classref-item-separator ---- .. _class_EditorExportPreset_method_is_runnable: .. rst-class:: classref-method :ref:`bool` **is_runnable**\ (\ ) |const| :ref:`🔗` 如果为导出对话框中打开了“可执行”开关，则返回 ``true``\ 。 .. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)` .. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)` .. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)` .. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)` .. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)` .. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)` .. |void| replace:: :abbr:`void (无返回值。)`