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 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, InputEvent[] actions_list ) |
void |
set_favorites ( PackedStringArray dirs ) |
void |
set_initial_value ( StringName name, Variant value, bool update_current ) |
void |
set_project_metadata ( String section, String key, Variant data ) |
void |
set_recent_dirs ( PackedStringArray dirs ) |
void |
set_setting ( String name, Variant value ) |
Signals¶
settings_changed ( )
Emitted after any editor setting has changed.
Constants¶
NOTIFICATION_EDITOR_SETTINGS_CHANGED = 10000 --- Emitted after any editor setting has changed. It's used by various editor plugins to update their visuals on theme changes or logic on configuration changes.
Property Descriptions¶
int debugger/profiler_frame_history_size
The size of the profiler's frame history. The default value (3600) allows seeing up to 60 seconds of profiling if the project renders at a constant 60 FPS. Higher values allow viewing longer periods of profiling in the graphs, especially when the project is running at high framerates.
bool docks/filesystem/always_show_folders
If true, displays folders in the FileSystem dock's bottom pane when split mode is enabled. If false, only files will be displayed in the bottom pane. Split mode can be toggled by pressing the icon next to the res:// folder path.
Note: This setting has no effect when split mode is disabled (which is the default).
String docks/filesystem/textfile_extensions
List of file extensions to consider as editable text files in the FileSystem dock (by double-clicking on the files).
int docks/filesystem/thumbnail_size
The thumbnail size to use in the FileSystem dock (in pixels). See also filesystem/file_dialog/thumbnail_size.
float docks/property_editor/auto_refresh_interval
The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector more often, but take up more CPU time.
float docks/property_editor/subresource_hue_tint
The tint intensity to use for the subresources background in the Inspector dock. The tint is used to distinguish between different subresources in the inspector. Higher values result in a more noticeable background color difference.
bool docks/scene_tree/auto_expand_to_selected
If true, the scene tree dock will automatically unfold nodes when a node that has folded parents is selected.
bool docks/scene_tree/start_create_dialog_fully_expanded
If true, the Create dialog (Create New Node/Create New Resource) will start with all its sections expanded. Otherwise, sections will be collapsed until the user starts searching (which will automatically expand sections as needed).
Color editors/2d/bone_color1
The "start" stop of the color gradient to use for bones in the 2D skeleton editor.
Color editors/2d/bone_color2
The "end" stop of the color gradient to use for bones in the 2D skeleton editor.
Color editors/2d/bone_ik_color
The color to use for inverse kinematics-enabled bones in the 2D skeleton editor.
Color editors/2d/bone_outline_color
The outline color to use for non-selected bones in the 2D skeleton editor. See also editors/2d/bone_selected_color.
int editors/2d/bone_outline_size
The outline size in the 2D skeleton editor (in pixels). See also editors/2d/bone_width.
Color editors/2d/bone_selected_color
The color to use for selected bones in the 2D skeleton editor. See also editors/2d/bone_outline_color.
int editors/2d/bone_width
The bone width in the 2D skeleton editor (in pixels). See also editors/2d/bone_outline_size.
bool editors/2d/constrain_editor_view
If true, prevents the 2D editor viewport from leaving the scene. Limits are calculated dynamically based on nodes present in the current scene. If false, the 2D editor viewport will be able to move freely, but you risk getting lost when zooming out too far. You can refocus on the scene by selecting a node then pressing F.
Color editors/2d/grid_color
The grid color to use in the 2D editor.
Color editors/2d/guides_color
The guides color to use in the 2D editor. Guides can be created by dragging the mouse cursor from the rulers.
Color editors/2d/smart_snapping_line_color
The color to use when drawing smart snapping lines in the 2D editor. The smart snapping lines will automatically display when moving 2D nodes if smart snapping is enabled in the Snapping Options menu at the top of the 2D editor viewport.
Color editors/2d/viewport_border_color
The color of the viewport border in the 2D editor. This border represents the viewport's size at the base resolution defined in the Project Settings. Objects placed outside this border will not be visible unless a Camera2D node is used, or unless the window is resized and the stretch mode is set to disabled.
float editors/3d/default_fov
The default camera field of view to use in the 3D editor (in degrees). The camera field of view can be adjusted on a per-scene basis using the View menu at the top of the 3D editor. If a scene had its camera field of view adjusted using the View menu, this setting is ignored in the scene in question. This setting is also ignored while a Camera3D node is being previewed in the editor.
float editors/3d/default_z_far
The default camera far clip distance to use in the 3D editor (in degrees). Higher values make it possible to view objects placed further away from the camera, at the cost of lower precision in the depth buffer (which can result in visible Z-fighting in the distance). The camera far clip distance can be adjusted on a per-scene basis using the View menu at the top of the 3D editor. If a scene had its camera far clip distance adjusted using the View menu, this setting is ignored in the scene in question. This setting is also ignored while a Camera3D node is being previewed in the editor.
float editors/3d/default_z_near
The default camera near clip distance to use in the 3D editor (in degrees). Lower values make it possible to view objects placed closer to the camera, at the cost of lower precision in the depth buffer (which can result in visible Z-fighting in the distance). The camera near clip distance can be ad