Attention
You are reading the latest
(unstable) version of this documentation, which may document features not available
or compatible with Godot 3.x.
Checking the stable version of the documentation...
Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0
. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
EditorSettingsΒΆ
Inherits: Resource < RefCounted < 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.
Property names use slash delimiters to distinguish sections. Setting values can be of any Variant type. It's recommended to use snake_case
for editor settings to be consistent with the Godot editor itself.
Accessing the settings can be done using the following methods, such as:
var settings = EditorInterface.get_editor_settings()
# `settings.set("some/property", 10)` also works as this class overrides `_set()` internally.
settings.set_setting("some/property", 10)
# `settings.get("some/property")` also works as this class overrides `_get()` internally.
settings.get_setting("some/property")
var list_of_settings = settings.get_property_list()
EditorSettings settings = GetEditorInterface().GetEditorSettings();
// `settings.set("some/property", value)` also works as this class overrides `_set()` internally.
settings.SetSetting("some/property", Value);
// `settings.get("some/property", value)` also works as this class overrides `_get()` internally.
settings.GetSetting("some/property");
Godot.Collections.Array<Godot.Collections.Dictionary> listOfSettings = settings.GetPropertyList();
Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.get_editor_settings.
PropertiesΒΆ
MethodsΒΆ
void |
add_property_info ( Dictionary info ) |
check_changed_settings_in_group ( String setting_prefix ) const |
|
void |
|
get_changed_settings ( ) const |
|
get_favorites ( ) const |
|
get_project_metadata ( String section, String key, Variant default=null ) const |
|
get_recent_dirs ( ) const |
|
get_setting ( String name ) const |
|
has_setting ( String name ) const |
|
void |
mark_setting_changed ( String setting ) |
void |
set_builtin_action_override ( String name, |