EditorSettings

Inherits: Resource < Reference < Object

保存与项目无关的编辑器设置的对象。

描述

保存与项目无关的编辑器设置的对象。这些设置通常在 编辑器 > 编辑器设置 菜单中可见。

属性名使用斜线分隔符来区分部分。设置值可以是任何 Variant 类型。建议使用snake_case进行编辑器设置，以便与Godot编辑器本身保持一致。

访问设置可以使用以下方法，例如。

# `settings.set("some/property", value)` also works as this class overrides `_set()` internally.
settings.set_setting("some/property",value)
# `settings.get("some/property", value)` also works as this class overrides `_get()` internally.
settings.get_setting("some/property")
var list_of_settings = settings.get_property_list()

注意:这个类不应该直接实例化，而是使用EditorInterface.get_editor_settings访问单子。相反，使用EditorInterface.get_editor_settings访问单例。

方法

信号

• settings_changed ( )

在编辑器设置改变后触发。

常量

• NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000 —- 在编辑器设置改变后触发。它被各种编辑器插件用于在主题变化时更新其视觉效果或在配置变化时更新逻辑。

方法说明

• void add_property_info ( Dictionary info )

将自定义属性信息添加到属性。该词典必须包含：

-名称：String（属性名称）

-类型：int（请参阅Variant.Type）

-（可选）提示：int（请参阅PropertyHint）和hint_string：String

示例：

editor_settings.set("category/property_name", 0)
var property_info = {
    "name": "category/property_name",
    "type": TYPE_INT,
    "hint": PROPERTY_HINT_ENUM,
    "hint_string": "one,two,three"
}
editor_settings.add_property_info(property_info)

• void erase ( String property )

删除名称为指定property的设置。

• PoolStringArray get_favorites ( ) const

返回本项目最收藏的文件和目录列表。

• Variant get_project_metadata ( String section, String key, Variant default=null ) const

返回指定的section和key的特定项目元数据。如果元数据不存在，将返回default。另请参阅 set_project_metadata。

• String get_project_settings_dir ( ) const

返回项目特定设置的路径。项目在设置路径中都有一个唯一的子目录，保存项目的特定设置。

• PoolStringArray get_recent_dirs ( ) const

返回此项目文件对话框中最近访问的文件夹列表。

• Variant get_setting ( String name ) const

返回 name 指定的设置的值。这相当于在EditorSettings实例上使用Object.get。

• String get_settings_dir ( ) const

获取引擎的全局设置路径。在此路径内，您可以找到一些标准路径，例如：

settings / tmp-用于文件的临时存储

settings/templates-导出模板所在的位置

• bool has_setting ( String name ) const

如果由名称 name 指定的设置存在，则返回 true，否则返回 false。

• bool property_can_revert ( String name )

如果name指定的设置可以将其值还原为默认值，则返回true，否则返回false。当此方法返回true时，编辑器设置中的设置旁边会显示一个还原按钮。

• Variant property_get_revert ( String name )

返回 name 指定的设置的默认值。当点击编辑器设置中的 “还原 “按钮时，该值将被应用。

• void set_favorites ( PoolStringArray dirs )

设置此项目为收藏的文件和目录列表。

• void set_initial_value ( String name, Variant value, bool update_current )

将 name 指定的设置的初始值设置为 value。这用于为编辑器设置中的“还原”按钮提供一个值。如果 update_current 为真，则设置的当前值也会被设置为 value。

• void set_project_metadata ( String section, String key, Variant data )

设置项目特定的元数据，并指定 section、key 和 data。这个元数据被保存在项目文件夹之外，因此不会被检查到版本控制中。参阅 get_project_metadata。

• void set_recent_dirs ( PoolStringArray dirs )

在文件对话框中设置本项目最近访问过的文件夹列表。

• void set_setting ( String name, Variant value )

设置 name 指定的设置的 value。这相当于在EditorSettings实例上使用Object.set。