EditorSettings

Inherits: Resource < Reference < Object

Object that holds the project-independent editor settings.

Description

Object that holds the project-independent editor settings. These settings are generally visible in the Editor > Editor Settings menu.

Accessing the settings is done by using the regular Object API, such as:

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

Signals

  • settings_changed ( )

Emitted when editor settings change.

Constants

  • NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000 — Emitted when editor settings change. It used by various editor plugins to update their visuals on theme changes or logic on configuration changes.

Method Descriptions

Adds a custom property info to a property. The dictionary must contain:

Example:

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 )

Erase a given setting (pass full property path).


Gets the list of favorite files and directories for this project.



  • String get_project_settings_dir ( ) const

Gets the specific project settings path. Projects all have a unique sub-directory inside the settings path where project specific settings are saved.


Gets the list of recently visited folders in the file dialog for this project.



  • String get_settings_dir ( ) const

Gets the global settings path for the engine. Inside this path, you can find some standard paths such as:

settings/tmp – Used for temporary storage of files

settings/templates – Where export templates are located





Sets the list of favorite files and directories for this project.




Sets the list of recently visited folders in the file dialog for this project.


Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.