EditorSettings

继承

Resource

简要描述

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

描述

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

使用常规的ObjectAPI可以访问设置，例如：

settings.set(prop,value)
settings.get(prop)
list_of_settings = settings.get_property_list()

方法

返回值类型	方法名称
void	add_property_info(info: Dictionary)
void	erase(property: String)
PoolStringArray	get_favorites() const
Variant	get_project_metadata(section: String, key: String, default: Variant = null) const
String	get_project_settings_dir() const
PoolStringArray	get_recent_dirs() const
Variant	get_setting(name: String) const
String	get_settings_dir() const
bool	has_setting(name: String) const
bool	property_can_revert(name: String)
Variant	property_get_revert(name: String)
void	set_favorites(dirs: PoolStringArray)
void	set_initial_value(name: String, value: Variant, update_current: bool)
void	set_project_metadata(section: String, key: String, data: Variant)
void	set_recent_dirs(dirs: PoolStringArray)
void	set_setting(name: String, value: Variant)

信号

• **settings_changed**

编辑器设置更改时发出。

---

方法说明

• add_property_info add_property_info(info: Dictionary)

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

• name: String（属性名称）

• type: int（见Variant.Type）

• optionally hint: 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)

---

• erase erase(property: String)

擦除给定的设置（传递完整的属性路径）。

---

• get_favorites get_favorites() const

获取此项目的收藏夹文件和目录的列表。

---

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

返回section和key指定的项目特定的元数据。如果元数据不存在，default则将返回该元数据。见set_project_metadata。

---

• get_project_settings_dir get_project_settings_dir() const

获取特定的项目设置路径。有项目在设置路径内都有一个唯一的子目录，用于保存特定于项目的设置。

---

• get_recent_dirs get_recent_dirs() const

在此项目的文件对话框中获取最近访问的文件夹的列表。

---

• get_setting get_setting(name: String) const

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

---

• get_settings_dir get_settings_dir() const

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

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

settings/templates-导出模板的位置

---

• has_setting has_setting(name: String) const

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

---

• property_can_revert property_can_revert(name: String)

返回true如果指定名称name的设置可以有其还原为默认值的值，否则返回false。

---

• property_get_revert property_get_revert(name: String)

返回由指定名称name的设置。这是单击“编辑器设置”中的“还原”按钮时将应用的值。

---

• set_favorites set_favorites(dirs: PoolStringArray)

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

---

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

将所指定名称name设置的初始值设为value。这用于为“编辑器设置”中的“还原”按钮提供值。

---

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

根据section，key和data设置项目特定的元数据。此元数据存储在项目文件夹的外部，因此不会被检入版本控制中。

---

• set_recent_dirs set_recent_dirs(dirs: PoolStringArray)

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

---

• set_setting set_setting(name: String, value: Variant)

设置指定名称name设置的值。

---