Object that holds the project-independent editor settings.
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.
Editor settings are saved automatically when changed.
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()Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.get_editor_settings().
A list of the available URLs that can be chosen in the Asset Store to fetch asset data. With the key being the name, and the value being the URL.
If true, the Asset Store uses multiple threads for its HTTP requests. This prevents the Asset Store from blocking the main thread for every loaded asset.
If true, automatically switches to the Remote scene tree when running the project from the editor. If false, stays on the Local scene tree when running the project from the editor.
Warning: Enabling this setting can cause stuttering when running a project with a large amount of nodes (typically a few thousands of nodes or more), even if the editor window isn't focused. This is due to the remote scene tree being updated every second regardless of whether the editor is focused.
If true, automatically switches to the Stack Trace panel when the debugger hits a breakpoint or steps.
The limit of how many remote nodes can be selected at once.
Warning: Increasing this value is not recommended, as selecting too many can make the editing and inspection of remote properties unreliable.
If true, enables collection of profiling data from non-GDScript Godot functions, such as engine class methods. Enabling this slows execution while profiling further.
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.
The maximum number of script functions that can be displayed per frame in the profiler. If there are more script functions called in a given profiler frame, these functions will be discarded from the profiling results entirely.
Note: This setting is only read when the profiler is first started, so changing it during profiling will have no effect.
The refresh interval for the remote inspector's properties (in seconds). Lower values are more reactive, but may cause stuttering while the project is running from the editor and the Remote scene tree is selected in the Scene tree dock.
The refresh interval for the remote scene tree (in seconds). Lower values are more reactive, but may cause stuttering while the project is running from the editor and the Remote scene tree is selected in the Scene tree dock.
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).
If true, displays a confirmation dialog when moving or duplicating items in the FileSystem dock. This dialog can also be bypassed by holding Shift.
A comma separated list of unsupported file extensions to show in the FileSystem dock, e.g. "ico,icns".
A comma separated list of file extensions to consider as editable text files in the FileSystem dock (by double-clicking on the files), e.g. "txt,md,cfg,ini,log,json,yml,yaml,toml,xml".
The thumbnail size to use in the FileSystem dock (in pixels). See also filesystem/file_dialog/thumbnail_size.
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 refresh more often, but take up more CPU time.
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.
If true, displays a confirmation dialog after left-clicking the "percent" icon next to a node name in the Scene tree dock. When clicked, this icon revokes the node's scene-unique name, which can impact the behavior of scripts that rely on this scene-unique name due to identifiers not being found anymore.
If true, the scene tree dock will automatically unfold nodes when a node that has folded parents is selected.
If true, new node created when reparenting node(s) will be positioned at the average position of the selected node(s).
If true, the scene tree dock will only show nodes that match the filter, without showing parents that don't. This settings can also be changed in the Scene dock's top menu.
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).
The outline color to use for non-selected bones in the 2D skeleton editor. See also editors/2d/bone_selected_color.
The outline size in the 2D skeleton editor (in pixels). See also editors/2d/bone_width.
Note: Changes to this value only apply after modifying a Bone2D node in any way, or closing and reopening the scene.
The color to use for selected bones in the 2D skeleton editor. See also editors/2d/bone_outline_color.
The bone width in the 2D skeleton editor (in pixels). See also editors/2d/bone_outline_size.
Note: Changes to this value only apply after modifying a Bone2D node in any way, or closing and reopening the scene.
The guides color to use in the 2D editor. Guides can be created by dragging the mouse cursor from the rulers.
The color to use for the selection rectangle that surrounds selected locked nodes in the 2D editor viewport.
The thickness of the coordinate ruler in the 2D editor. Increasing this will also increase the size of the ruler font, improving readability when using a lower editor scale. The editor may force a minimum size to keep the ruler numbers legible.
The color to use for the selection rectangle outlines that surrounds selected nodes in the 2D editor viewport.
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.
If true, the 2D editor will snap to integer zoom values when not holding the Alt key. If false, this behavior is swapped.
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.
The factor to use when zooming in or out in the 2D editor. For example, 1.1 will zoom in by 10% with every step. If set to 2.0, zooming will only cycle through powers of two.
The color to use for the active selection box that surrounds selected nodes in the 3D editor viewport.
Note: The term "active" indicates that this object is the primary selection used as the basis for certain operations. This is the last selected Node3D, which can be reordered with Shift + Left mouse button.
The default camera vertical 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.
Note: The editor camera always uses the Keep Height aspect mode.
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.
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 adjusted on a per-scene basis using the View menu at the top of the 3D editor. If a scene had its camera near 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.
The modifier key to use to enable freelook in the 3D editor (on top of pressing the right mouse button).
Note: Regardless of this setting, the freelook toggle keyboard shortcut (Shift + F by default) is always available.
Note: On certain window managers on Linux, the Alt key will be intercepted by the window manager when clicking a mouse button at the same time. This means Godot will not see the modifier key as being pressed.
The base 3D freelook speed in units per second. This can be adjusted by using the mouse wheel while in freelook mode, or by holding down the "fast" or "slow" modifier keys (Shift and Alt by default, respectively).
The inertia of the 3D freelook camera. Higher values make the camera start and stop slower, which looks smoother but adds latency.
The mouse sensitivity to use while freelook mode is active in the 3D editor. See also editors/3d/navigation_feel/orbit_sensitivity.
The grid division bias to use in the 3D editor. Negative values will cause small grid divisions to appear earlier, whereas positive values will cause small grid divisions to appear later.
The largest grid division to use in the 3D editor. Together with editors/3d/primary_grid_steps, this determines how large the grid divisions can be. The grid divisions will not be able to get larger than primary_grid_steps ^ grid_division_level_max units. By default, when editors/3d/primary_grid_steps is 8, this means grid divisions cannot get larger than 64 units each (so primary grid lines are 512 units apart), no matter how far away the camera is from the grid.
The smallest grid division to use in the 3D editor. Together with editors/3d/primary_grid_steps, this determines how small the grid divisions can be. The grid divisions will not be able to get smaller than primary_grid_steps ^ grid_division_level_min units. By default, this means grid divisions cannot get smaller than 1 unit each, no matter how close the camera is from the grid.
The grid size in units. Higher values prevent the grid from appearing "cut off" at certain angles, but make the grid more demanding to render. Depending on the camera's position, the grid may not be fully visible since a shader is used to fade it progressively.
If true, renders the grid on the XY plane in perspective view. This can be useful for 3D side-scrolling games.
If true, renders the grid on the YZ plane in perspective view. This can be useful for 3D side-scrolling games.
If set above 0, where a primary grid line should be drawn. By default, primary lines are configured to be more visible than secondary lines. This helps with measurements in the 3D editor. See also editors/3d/primary_grid_color and editors/3d/secondary_grid_color.
The color to use for the secondary 3D grid. This is generally a less visible color than editors/3d/primary_grid_color. The color's alpha channel affects the grid's opacity.
The scale of the outer circle of the rotation gizmo as view plane rotation in the 3D editor. If set to 2.0, the outer circle has twice the radius of the XYZ rotation gizmo sphere.
The color to use for the AABB gizmo that displays the GeometryInstance3D's custom AABB.
The 3D editor gizmo color for CSG nodes (such as CSGShape3D or CSGBox3D).
The 3D editor gizmo color for the GridMap grid.
The 3D editor gizmo color for the IKModifier3D guides.
The color override to use for 3D editor gizmos if the Node3D in question is part of an instantiated scene file (from the perspective of the current scene).
The 3D editor gizmo color for Joint3Ds and PhysicalBone3Ds.
Color for representing Joint3D.node_a for some Joint3D types.
Color for representing Joint3D.node_b for some Joint3D types.
Color of lines displayed in baked LightmapGI node's grid.
The 3D editor gizmo color used for LightmapProbe nodes.
The 3D editor gizmo color used for OccluderInstance3D nodes.
The 3D editor gizmo color used for GPUParticlesAttractor3D nodes.
The 3D editor gizmo color used for GPUParticlesCollision3D nodes.
The 3D editor gizmo color used for CPUParticles3D and GPUParticles3D nodes.
The 3D editor gizmo color used for ReflectionProbe nodes.
The 3D editor gizmo color used for the currently selected Skeleton3D bone.
The 3D editor gizmo color used for Skeleton3D nodes.
The 3D editor gizmo color used for SpringBoneCollision3D nodes.
The 3D editor gizmo color used for SpringBoneCollision3D nodes with inside mode.
The 3D editor gizmo color used for SpringBoneSimulator3D nodes.
The 3D editor gizmo color used for AudioStreamPlayer3D's emission angle.
The 3D editor gizmo color used for VisibleOnScreenNotifier3D and VisibleOnScreenEnabler3D nodes.
The length of Skeleton3D bone gizmos in the 3D editor.
The shape of Skeleton3D bone gizmos in the 3D editor. Wire is a thin line, while Octahedron is a set of lines that represent a thicker hollow line pointing in a specific direction (similar to most 3D animation software).
Size of probe gizmos displayed when editing LightmapGI and LightmapProbe nodes. Setting this to 0.0 will hide the probe spheres of LightmapGI and wireframes of LightmapProbe nodes, but will keep the wireframes linking probes from LightmapGI and billboard icons from LightmapProbe intact.
Size of the disk gizmo displayed when editing Path3D's tilt handles.
If true, collision shapes in the 3D editor are visible only when selected. If false, collision shapes are always visible.
If true, automatically updates animation tracks' target paths when renaming or reparenting nodes in the Scene tree dock.
If true, display a confirmation dialog when adding a new track to an animation by pressing the "key" icon next to a property. Holding Shift will bypass the dialog.
If false, the behavior is reversed, i.e. the dialog only appears when Shift is held.
Default step used when creating a new Animation in the Animation bottom panel. Only affects the first animation created in the AnimationPlayer. By default, other newly created animations will use the step from the previous ones.
This value is always expressed in seconds. If you want e.g. 10 FPS to be the default, you need to set the default step to 0.1.
If true, create a Bezier track instead of a standard track when pressing the "key" icon next to a property. Bezier tracks provide more control over animation curves, but are more difficult to adjust quickly.
If true, create a RESET track when creating a new animation track. This track can be used to restore the animation to a "default" state.
Controls whether AnimationPlayer will apply snapping to nearest integer FPS when snapping is in Seconds mode. The option is remembered locally for a scene and this option only determines the default value when scene doesn't have local state yet.
Default step mode for AnimationPlayer (seconds or FPS). The option is remembered locally for a scene and this option only determines the default value when scene doesn't have local state yet.
If true, animation keys and markers are inserted at the current time in the animation.
If false, they are inserted at the mouse cursor's position.
The modulate color to use for "future" frames displayed in the animation editor's onion skinning feature.
The modulate color to use for "past" frames displayed in the animation editor's onion skinning feature.
The maximum distance at which tiles can be placed on a GridMap, relative to the camera position (in 3D units).
The panning speed when using the mouse wheel or touchscreen events in the 2D editor. This setting does not apply to panning by holding down the middle or right mouse buttons.
Controls whether the mouse wheel scroll zooms or pans in the 2D editor. See also editors/panning/sub_editors_panning_scheme and editors/panning/animation_editors_panning_scheme.
Controls whether the mouse wheel scroll zooms or pans in the animation track and Bezier editors. See also editors/panning/2d_editor_panning_scheme and editors/panning/sub_editors_panning_scheme (which controls the animation blend tree editor's pan behavior).
If true, allows panning by holding down Space in the 2D editor viewport (in addition to panning with the middle or right mouse buttons). If false, the left mouse button must be held down while holding down Space to pan in the 2D editor viewport.
Controls whether the mouse wheel scroll zooms or pans in subeditors. The list of affected subeditors is: animation blend tree editor, Polygon2D editor, tileset editor, texture region editor and visual shader editor. See also editors/panning/2d_editor_panning_scheme and editors/panning/animation_editors_panning_scheme.
If true, warps the mouse around the 2D viewport while panning in the 2D editor. This makes it possible to pan over a large area without having to exit panning and adjust the mouse cursor.
The mouse cursor movement direction to use when drag-zooming in any editor (except 3D scene editor) by moving the mouse. This does not affect zooming with the mouse wheel.
The delay in seconds until more complex and performance costly polygon editors commit their outlines, e.g. the 2D navigation polygon editor rebakes the navigation mesh polygons. A negative value stops the auto bake.
The radius in which points can be selected in the Polygon2D and CollisionPolygon2D editors (in pixels). Higher values make it easier to select points quickly, but can make it more difficult to select the expected point when several points are located close to each other.
If true, displays the polygon's previous shape in the 2D polygon editors with an opaque gray outline. This outline is displayed while dragging a point until the left mouse button is released.
If true, displays a grid while the TileMap editor is active. See also editors/tiles_editor/grid_color.
The color to use for the TileMap editor's grid.
Note: Only effective if editors/tiles_editor/display_grid is true.
The curvature to use for connection lines in the visual shader editor. Higher values will make connection lines appear more curved, with values above 0.5 resulting in more "angular" turns in the middle of connection lines.
The size to use for port previews in the visual shader uniforms (toggled by clicking the "eye" icon next to an output). The value is defined in pixels at 100% zoom, and will scale with zoom automatically.
Path to the SCP (secure copy) executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run scp from PATH.
Note: SCP is not the same as SFTP. Specifying the SFTP executable here will not work.
Path to the SSH executable (used for remote deploy to desktop platforms). If left empty, the editor will attempt to run ssh from PATH.
The folder where projects should be scanned for (recursively), in a way similar to the project manager's Scan button. This can be set to the same value as filesystem/directories/default_project_path for convenience.
Note: Setting this path to a folder with very large amounts of files/folders can slow down the project manager startup significantly. To keep the project manager quick to start up, it is recommended to set this value to a folder as "specific" as possible.
The folder where new projects should be created by default when clicking the project manager's New Project button. This can be set to the same value as filesystem/directories/autoscan_project_path for convenience.
The program that opens 3D model scene files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
The program that opens audio files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
The program that opens raster image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
The terminal emulator program to use when using Open in Terminal context menu action in the FileSystem dock. You can enter an absolute path to a program binary, or a path to a program that is present in the PATH environment variable.
If left empty, Godot will use the default terminal emulator for the system:
- Windows: PowerShell
- macOS: Terminal.app
- Linux: The first terminal found on the system in this order: gnome-terminal, konsole, xfce4-terminal, lxterminal, kitty, alacritty, urxvt, xterm.
To use Command Prompt (cmd) instead of PowerShell on Windows, enter cmd in this field and the correct flags will automatically be used.
On macOS, make sure to point to the actual program binary located within the Programs/MacOS folder of the .app bundle, rather than the .app bundle directory.
If specifying a custom terminal emulator, you may need to override filesystem/external_programs/terminal_emulator_flags so it opens in the correct folder.
The command-line arguments to pass to the terminal emulator that is run when using Open in Terminal context menu action in the FileSystem dock. See also filesystem/external_programs/terminal_emulator.
If left empty, the default flags are {directory}, which is replaced by the absolute path to the directory that is being opened in the terminal.
Note: If the terminal emulator is set to PowerShell, cmd, or Konsole, Godot will automatically prepend arguments to this list, as these terminals require nonstandard arguments to open in the correct folder.
The program that opens vector image files when clicking "Open in External Program" option in Filesystem Dock. If not specified, the file will be opened in the system's default program.
The display mode to use in the editor's file dialogs.
- Thumbnails takes more space, but displays dynamic resource thumbnails, making resources easier to preview without having to open them.
- List is more compact but doesn't display dynamic resource thumbnails. Instead, it displays static icons based on the file extension.
The thumbnail size to use in the editor's file dialogs (in pixels). See also docks/filesystem/thumbnail_size.
The path to the Blender executable used for converting the Blender 3D scene files .blend to glTF 2.0 format during import. Blender 3.0 or later is required.
To enable this feature for your specific project, use ProjectSettings.filesystem/import/blender/enabled.
If this setting is empty, Blender's default paths will be detected and used automatically if present in this order:
Windows:
- C:\Program Files\Blender Foundation\blender.exe
- C:\Program Files (x86)\Blender Foundation\blender.exemacOS:
- /opt/homebrew/bin/blender
- /opt/local/bin/blender
- /usr/local/bin/blender
- /usr/local/opt/blender
- /Applications/Blender.app/Contents/MacOS/BlenderLinux/*BSD:
- /usr/bin/blender
- /usr/local/bin/blender
- /opt/blender/bin/blenderThe port number used for Remote Procedure Call (RPC) communication with Godot's created process of the blender executable.
Setting this to 0 effectively disables communication with Godot and the blender process, making performance slower.
The maximum idle uptime (in seconds) of the Blender process.
This prevents Godot from having to create a new process for each import within the given seconds.
The path to the FBX2glTF executable used for converting Autodesk FBX 3D scene files .fbx to glTF 2.0 format during import.
To enable this feature for your specific project, use ProjectSettings.filesystem/import/fbx2gltf/enabled.
If true, when saving a file, the editor will rename the old file to a different name, save a new file, then only remove the old file once the new file has been saved. This makes loss of data less likely to happen if the editor or operating system exits unexpectedly while saving (e.g. due to a crash or power outage).
Note: On Windows, this feature can interact negatively with certain antivirus programs. In this case, you may have to set this to false to prevent file locking issues.
If true, displays a warning toast message when saving a text-based scene or resource that is larger than 500 KiB on disk. This is typically caused by binary subresources being embedded as text, which results in slow and inefficient conversion to text. This in turn impacts scene saving and loading times.
This should usually be resolved by moving the embedded binary subresource to its own binary resource file (.res extension instead of .tres). This is the preferred approach. Alternatively, the entire scene can be saved with the binary .scn format as opposed to .tscn, but this will make it less friendly to version control systems.
If set to Adaptive, the dialog opens in list view or grid view depending on the requested type. If set to Last Used, the display mode will always open the way you last used it.
If true, together with exact matches of a filename, the dialog includes approximate matches.
This is useful for finding the correct files even when there are typos in the search query; for example, searching "nprmal" will find "normal". Additionally, it allows you to write shorter search queries; for example, searching "nml" will also find "normal".
If true, highlighting a resource will preview it quickly without confirming the selection or closing the dialog.
The number of missed query characters allowed in a match when fuzzy matching is enabled. For example, with the default value of 2, "normal" would match "narmal" and "norma" but not "nor".
The path to the directory containing the Open Image Denoise (OIDN) executable, used optionally for denoising lightmaps. It can be downloaded from openimagedenoise.org.
To enable this feature for your specific project, use ProjectSettings.rendering/lightmapping/denoising/denoiser.
If true, input events will be flushed just before every idle and physics frame.
If false, these events will be flushed only once per process frame, between iterations of the engine.
Enabling this setting can greatly improve input responsiveness, especially in devices that struggle to run at the project's intended frame rate.
If true, similar input events sent by the operating system are accumulated. When input accumulation is enabled, all input events generated during a frame will be merged and emitted when the frame is done rendering. Therefore, this limits the number of input method calls per second to the rendering FPS.
Input accumulation can be disabled to get slightly more precise/reactive input at the cost of increased CPU usage.
Note: Input accumulation is enabled by default.
Editor accessibility support mode:
- Auto (0): Accessibility support is enabled, but updates to the accessibility information are processed only if an assistive app (such as a screen reader or a Braille display) is active (default).
- Always Active (1): Accessibility support is enabled, and updates to the accessibility information are always processed, regardless of the status of assistive apps.
- Disabled (2): Accessibility support is fully disabled.
Note: Accessibility debugging tools, such as Accessibility Insights for Windows, Accessibility Inspector (macOS), or AT-SPI Browser (Linux/BSD), do not count as assistive apps. To test the editor with these tools, use Always Active.
How to position the Cancel and OK buttons in the editor's AcceptDialog windows. Different platforms have different conventions for this, which can be overridden through this setting to avoid accidental clicks when using Godot on multiple platforms.
- Auto follows the platform convention: OK first on Windows, KDE, and LXQt; Cancel first on macOS and other Linux desktop environments.
- Cancel First forces the Cancel/OK ordering.
- OK First forces the OK/Cancel ordering.
To check if these buttons are swapped at runtime, use DisplayServer.get_swap_cancel_ok().
The custom editor scale factor to use. This can be used for displays with very high DPI where a scale factor of 200% is not sufficient.
Note: Only effective if interface/editor/appearance/display_scale is set to Custom.
The display scale factor to use for the editor interface. Higher values are more suited to hiDPI/Retina displays.
If set to Auto, the editor scale is automatically determined based on the screen resolution and reported display DPI. This heuristic is not always ideal, which means you can get better results by setting the editor scale manually.
If set to Custom, the scaling value in interface/editor/appearance/custom_display_scale will be used.
The preferred monitor to display the editor. If Auto, the editor will remember the last screen it was displayed on across multiple sessions.
Expanding main editor window content to the title, if supported by DisplayServer. See DisplayServer.WINDOW_FLAG_EXTEND_TO_TITLE.
Specific to the macOS platform.
If true, a renderer selector that can be used to change the ProjectSettings.rendering/renderer/rendering_method project setting will be shown in the top right of the main editor window.
If enabled, displays an icon in the top-right corner of the editor that spins when the editor redraws a frame. This can be used to diagnose situations where the engine is constantly redrawing, which should be avoided as this increases CPU and GPU utilization for no good reason. To further troubleshoot these situations, start the editor with the --debug-canvas-item-redraw command line argument.
Consider enabling this if you are developing editor plugins to ensure they only make the editor redraw when required.
The default Auto value will only enable this if the editor was compiled with the dev_build=yes SCons option (the default is dev_build=no).
Note: If interface/editor/display/update_continuously is true, the spinner icon displays in red.
Note: If the editor was started with the --debug-canvas-item-redraw command line argument, the update spinner will never display regardless of this setting's value. This is to avoid confusion with what would cause redrawing in real world scenarios.
If true, automatically opens screenshots with the default program associated to .png files after a screenshot is taken using the Editor > Take Screenshot action.
If true, (re)imports resources even if the editor window is unfocused or minimized. If false, resources are only (re)imported when the editor window is focused. This can be set to true to speed up iteration by starting the import process earlier when saving files in the project folder. This also allows getting visual feedback on changes without having to click the editor window, which is useful with multi-monitor setups. The downside of setting this to true is that it increases idle CPU usage and may steal CPU time from other applications when importing resources.
If false, the editor will save all scenes when confirming the Save action when quitting the editor or quitting to the project list. If true, the editor will ask to save each scene individually.
If true, scenes and scripts are saved when the editor loses focus. Depending on the work flow, this behavior can be less intrusive than text_editor/behavior/files/autosave_interval_secs or remembering to save manually.
If true, the editor's Script tab will have a separate distraction mode setting from the 2D/3D/Game/AssetLib tabs. If false, the distraction-free mode toggle is shared between all tabs.
If enabled, displays internal engine errors in toast notifications (toggleable by clicking the "bell" icon at the bottom of the editor). No matter the value of this setting, non-internal engine errors will always be visible in toast notifications.
The default Auto value will only enable this if the editor was compiled with the dev_build=yes SCons option (the default is dev_build=no).
If true, keeps the screen on (even in case of inactivity), so the screensaver does not take over. Works on desktop and mobile platforms.
If true, embed modal windows such as docks inside the main editor window. When single-window mode is enabled, tooltips will also be embedded inside the main editor window, which means they can't be displayed outside of the editor window. Single-window mode can be faster as it does not need to create a separate window for every popup and tooltip, which can be a slow operation depending on the operating system and rendering method in use.
This is equivalent to ProjectSettings.display/window/subwindows/embed_subwindows in the running project, except the setting's value is inverted.
Note: To query whether the editor can use multiple windows in an editor plugin, use EditorInterface.is_multi_window_enabled() instead of querying the value of this editor setting.
Note: If true, game embedding is disabled.
If true, redraws the editor every frame even if nothing has changed on screen. When this setting is enabled, the update spinner displays in red (see interface/editor/appearance/show_update_spinner).
Warning: This greatly increases CPU and GPU utilization, leading to increased power usage. This should only be enabled for troubleshooting purposes.
Sets the V-Sync mode for the editor. Does not affect the project when run from the editor (this is controlled by ProjectSettings.display/window/vsync/vsync_mode).
Depending on the platform and used renderer, the engine will fall back to Enabled if the desired mode is not supported.
Note: V-Sync modes other than Enabled are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
The font to use for the script editor. Must be a resource of a Font type such as a .ttf or .otf font file.
The font ligatures to enable for the currently configured code font. Not all fonts include support for ligatures.
Note: The default editor code font (JetBrains Mono) has contextual ligatures in its font file.
List of custom OpenType features to use, if supported by the currently configured code font. Not all fonts include support for custom OpenType features. The string should follow the OpenType specification.
Note: The default editor code font (JetBrains Mono) has custom OpenType features in its font file, but there is no documented list yet.
List of alternative characters to use, if supported by the currently configured code font. Not all fonts include support for custom variations. The string should follow the OpenType specification.
Note: The default editor code font (JetBrains Mono) has alternate characters in its font file, but there is no documented list yet.
The size of the font in the script editor. This setting does not impact the font size of the Output panel (see run/output/font_size).
If set to true, MSDF font rendering will be used for the visual shader graph editor. You may need to set this to false when using a custom main font, as some fonts will look broken due to the use of self-intersecting outlines in their font data. Downloading the font from the font maker's official website as opposed to a service like Google Fonts can help resolve this issue.
FreeType's font anti-aliasing mode used to render the editor fonts. Most fonts are not designed to look good with anti-aliasing disabled, so it's recommended to leave this enabled unless you're using a pixel art font.
If set to true, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
The font hinting mode to use for the editor fonts. FreeType supports the following font hinting modes:
- None: Don't use font hinting when rasterizing the font. This results in a smooth font, but it can look blurry.
- Light: Use hinting on the X axis only. This is a compromise between font sharpness and smoothness.
- Normal: Use hinting on both X and Y axes. This results in a sharp font, but it doesn't look very smooth.
If set to Auto, the font hinting mode will be set to match the current operating system in use. This means the Light hinting mode will be used on Windows and Linux, and the None hinting mode will be used on macOS.
The subpixel positioning mode to use when rendering editor font glyphs. This affects both the main and code fonts. Disabled is the fastest to render and uses the least memory. Auto only uses subpixel positioning for small font sizes (where the benefit is the most noticeable). One Half of a Pixel and One Quarter of a Pixel force the same subpixel positioning mode for all editor fonts, regardless of their size (with One Quarter of a Pixel being the highest-quality option).
The font to use for the editor interface. Must be a resource of a Font type such as a .ttf or .otf font file.
Note: If the provided font is variable, a weight of 400 (normal) will be used.
The font to use for bold text in the editor interface. Must be a resource of a Font type such as a .ttf or .otf font file.
Note: If the provided font is variable, a weight of 700 (bold) will be used.
List of custom OpenType features to use, if supported by the currently configured main font. Check what OpenType features are supported by your font first.
The string should follow the OpenType specification, e.g. ss01,tnum,calt=false. Microsoft's documentation contains a list of all registered features.
Note: The default editor main font (Inter) has custom OpenType features in its font file, with ss04 and tnum enabled and calt disabled by default. Supported features can be found at its website.
The language to use for the editor interface. If set to Auto, the language is automatically determined based on the system locale. See also EditorInterface.get_editor_language().
Translations are provided by the community. If you spot a mistake, contribute to editor translations on Weblate!
If true, setting names in the editor are localized when possible.
Note: This setting affects most EditorInspectors in the editor UI, primarily Project Settings and Editor Settings. To control names displayed in the Inspector dock, use interface/inspector/default_property_name_style instead.
During a drag-and-drop, this is how long to wait over a UI element before it triggers a reaction (e.g. a section unfolds to show nested items).
The amount of sleeping between frames in the editor (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops. However, higher values will result in a less responsive editor. The default value is set to allow for maximum smoothness on monitors up to 144 Hz. See also interface/editor/timers/unfocused_low_processor_mode_sleep_usec.
Note: This setting is ignored if interface/editor/display/update_continuously is true, as enabling that setting disables low-processor mode.
When the editor window is unfocused, the amount of sleeping between frames when the low-processor usage mode is enabled (in microseconds). Higher values will result in lower CPU/GPU usage, which can improve battery life on laptops (in addition to improving the running project's performance if the editor has to redraw continuously). However, higher values will result in a less responsive editor. The default value is set to limit the editor to 10 FPS when the editor window is unfocused. See also interface/editor/timers/low_processor_mode_sleep_usec.
Note: This setting is ignored if interface/editor/display/update_continuously is true, as enabling that setting disables low-processor mode.
If true, when extending a script, the global class name of the script is inserted in the script creation dialog, if it exists. If false, the script's file path is always inserted.
If true, automatically unfolds Inspector property groups containing modified values when opening a scene for the first time. Only affects scenes without saved folding preferences and only unfolds groups with properties that have been changed from their default values.
Note: This setting only works in specific scenarios: when opening a scene brought in from another project, or when opening a new scene that already has modified properties (e.g., from version control). Duplicated scenes are not considered foreign, so this setting will not affect them.
If true, show the intensity slider in the ColorPickers opened in the editor.
The default color picker mode to use when opening ColorPickers in the editor. This mode can be temporarily adjusted on the color picker itself.
The default color picker shape to use when opening ColorPickers in the editor. This shape can be temporarily adjusted on the color picker itself.
The floating-point precision to use for properties that don't define an explicit precision step. Lower values allow entering more precise values.
The default property name style to display in the Inspector dock. This style can be temporarily adjusted in the Inspector dock's menu.
- Raw: Displays properties in snake_case.
- Capitalized: Displays properties capitalized.
- Localized: Displays the localized string for the current editor language if a translation is available for the given property. If no translation is available, falls back to Capitalized.
Note: To display translated setting names in Project Settings and Editor Settings, use interface/editor/localization/localize_settings instead.
If true, add a margin around Array, Dictionary, and Resource Editors that are not already colored.
Note: If interface/inspector/nested_color_mode is set to Containers & Resources this parameter will have no effect since those editors will already be colored.
If true, forces all property groups to be expanded in the Inspector dock and prevents collapsing them.
The number of Array or Dictionary items to display on each "page" in the inspector. Higher values allow viewing more values per page, but take more time to load. This increased load time is noticeable when selecting nodes that have array or dictionary properties in the editor.
Control which property editors are colored when they are opened.
- Containers & Resources: Color all Array, Dictionary, and Resource Editors.
- Resources: Color all Resource Editors.
- External Resources: Color Resource Editors that edits an external resource.
If true, subresources can be edited in the current inspector view. If the resource type is defined in interface/inspector/resources_to_open_in_new_inspector or if this setting is false, attempting to edit a subresource always opens a new inspector view.
List of resources that should always be opened in a new inspector view, even if interface/inspector/open_resources_in_current_inspector is true.
If true, display OpenType features marked as hidden by the font file in the Font editor.
If true, multiple window support in editor is enabled. The following panels can become dedicated windows (i.e. made floating): Docks, Script editor, Shader editor, and Game Workspace.
Note: When interface/editor/display/single_window_mode is true, the multi window support is always disabled.
Note: To query whether the editor can use multiple windows in an editor plugin, use EditorInterface.is_multi_window_enabled() instead of querying the value of this editor setting.
If true, when panels are made floating they will be maximized.
If false, when panels are made floating their position and size will match the ones when they are attached (excluding window border) to the editor window.
If true, the floating panel position, size, and screen will be saved on editor exit. On next launch the panels that were floating will be made floating in the saved positions, sizes and screens, if possible.
If true, when a project is loaded, restores scenes that were opened on the last editor session.
Note: With many opened scenes, the editor may take longer to become usable. If starting the editor quickly is necessary, consider setting this to false.
If true, show a button next to each scene tab that opens the scene's "dominant" script when clicked. The "dominant" script is the one that is at the highest level in the scene's hierarchy.
If true, display an automatically-generated thumbnail when hovering scene tabs with the mouse. Scene thumbnails are generated when saving the scene.
The color to use for "highlighted" user interface elements in the editor (pressed and hovered items).
The extra spacing to add to various GUI elements in the editor (in pixels). Increasing this value is useful to improve usability on touch screens, at the cost of reducing the amount of usable screen real estate.
See also interface/theme/spacing_preset.
The base color to use for user interface elements in the editor. Secondary colors (such as darker/lighter variants) are derived from this color.
The base spacing used by various GUI elements in the editor (in pixels). See also interface/theme/spacing_preset.
The contrast factor to use when deriving the editor theme's base color (see interface/theme/base_color). When using positive values, the derived colors will be darker than the base color. This contrast factor can be set to a negative value, which will make the derived colors brighter than the base color. Negative contrast rates often look better for light themes.
The custom theme resource to use for the editor. Must be a Godot theme resource in .tres or .res format.
If true, draws additional borders around interactive UI elements in the editor. This is automatically enabled when using the Black (OLED) theme preset, as this theme preset uses a fully black background.
What relationship lines to draw in the editor's Tree-based GUIs (such as the Scene tree dock).
- None will make it so that no relationship lines are drawn.
- Selected Only will only draw them for selected items.
- All will always draw them for all items.
The icon and font color scheme to use in the editor.
- Auto determines the color scheme to use automatically based on interface/theme/base_color.
- Dark makes fonts and icons dark (suitable for light themes). Icon colors are automatically converted by the editor following the set of rules defined in this file.
- Light makes fonts and icons light (suitable for dark themes).
The saturation to use for editor icons. Higher values result in more vibrant colors.
Note: The default editor icon saturation was increased by 30% in Godot 4.0 and later. To get Godot 3.x's icon saturation back, set interface/theme/icon_saturation to 0.77.
The opacity to use when drawing relationship lines in the editor's Tree-based GUIs (such as the Scene tree dock).
The editor theme spacing preset to use. See also interface/theme/base_spacing and interface/theme/additional_spacing.
If true, use the monospace font for some labels in the editor that display code symbols, such as signals, properties, and methods.
If true, set accent color based on system settings.
Note: This setting is effective on Windows, macOS, Linux, and Android.
If true, long press on touchscreen is treated as right click.
Note: Defaults to true on touchscreen devices.
If true, enable two finger pan and scale gestures on touchscreen devices.
Note: Defaults to true on touchscreen devices.
If true, increases the scrollbar touch area, enables a larger dragger for split containers, and increases PopupMenu vertical separation to improve usability on touchscreen devices.
Note: Defaults to true on touchscreen devices.
If true, the device will vibrate when a long-press gesture triggers a right-click context menu in the editor.
Note: Only has an effect on devices with haptic feedback hardware. Defaults to true on touchscreen devices.
Specify the multiplier to apply to the scale for the editor gizmo handles to improve usability on touchscreen devices.
Note: Defaults to 1 on non-touchscreen devices.
A touch-friendly panel that provides easy access to common actions such as save, delete, undo, and redo without requiring a keyboard.
Note: Only available in the Android and XR editor.
Specifies how the engine should check for updates.
- Disable Update Checks will block the engine from checking updates (see also network/connection/network_mode).
- Auto (default) will check for newest stable or unstable version, depending on which version are you currently using. Switch to another option if you want to lock in.
- Check Newest Preview will check for the newest available development snapshot.
- Check Newest Stable will check for the newest available stable version.
- Check Newest Patch will check for the latest available stable version, but only within the same minor version. E.g. if your version is 4.3.stable, you will be notified about 4.3.1.stable, but not 4.4.stable.
All update modes will ignore builds with different major versions (e.g. Godot 4 -> Godot 5).
Determines whether online features, such as the Asset Store or update checks, are enabled in the editor. If this is a privacy concern, disabling these online features prevents the editor from making HTTP requests to the Godot website or third-party platforms hosting assets from the Asset Store.
Editor plugins and tool scripts are recommended to follow this setting. However, Godot can't prevent them from violating this rule.
The address to listen to when starting the remote debugger. This can be set to this device's local IP address to allow external clients to connect to the remote debugger (instead of restricting the remote debugger to connections from localhost).
The port to listen to when starting the remote debugger. Godot will try to use port numbers above the configured number if the configured number is already taken by another application.
The host to use to contact the HTTP and HTTPS proxy in the editor (for the asset store and export template downloads). See also network/http_proxy/port.
Note: Godot currently doesn't automatically use system proxy settings, so you have to enter them manually here if needed.
The port number to use to contact the HTTP and HTTPS proxy in the editor (for the asset store and export template downloads). See also network/http_proxy/host.
Note: Godot currently doesn't automatically use system proxy settings, so you have to enter them manually here if needed.
If true the language server will try to provide additional results when resolving symbols at the cost of showing wrong results. All symbols in the project are checked and resolved just based on their name, without taking context into account.
func untyped(param):
param.print() # Will resolve to the global print method for e.g. hover hints.When using static typing it is recommended to disable this setting, since it will mostly add false positives for typed code.
Note: This setting also influences how symbols are resolved when using renaming capabilities.
Note: The default value of this setting might change in future versions.
The port used to listen for language server clients.
Note: A port configured with command-line options will take priority over this setting: --lsp-port <port>.
The declaration of native symbols can't be resolved to a position in the file system. If true the language server will instead open the documentation for native symbols in the editor.
Note: The VSCode plugin adds additional functionality which allows viewing Godot documentation directly in VSCode, so this option is usually not needed in VSCode.
The TLS certificate bundle to use for HTTP requests made within the editor (e.g. from the Asset Store tab). If left empty, the included Mozilla certificate bundle will be used.
If true, enable TLSv1.3 negotiation.
Note: Only supported when using Mbed TLS 3.0 or later (Linux distribution packages may be compiled against older system Mbed TLS packages), otherwise the maximum supported TLS version is always TLSv1.2.
The renderer type that will be checked off by default when creating a new project. Accepted strings are "forward_plus", "mobile" or "gl_compatibility".
Directory naming convention for the project manager. Options are "No Convention" (project name is directory name), "kebab-case" (default), "snake_case", "camelCase", "PascalCase", or "Title Case".
The sorting order to use in the project manager. When changing the sorting order in the project manager, this setting is set permanently in the editor settings.
If true, saves all scenes and scripts automatically before running the project. Setting this to false prevents the editor from saving if there are no changes which can speed up the project startup slightly, but it makes it possible to run a project that has unsaved changes. (Unsaved changes will not be visible in the running project.)
The action to execute on the bottom panel when running the project.
Note: This option won't do anything if the bottom panel switching is locked using the pin button in the corner of the bottom panel.
The action to execute on the bottom panel when stopping the project.
Note: This option won't do anything if the bottom panel switching is locked using the pin button in the corner of the bottom panel.
The size of the font in the Output panel at the bottom of the editor. This setting does not impact the font size of the script editor (see interface/editor/fonts/code_font_size).
Specifies how the Play window is launched relative to the Android editor.
- Auto (based on screen size) (default) will automatically choose how to launch the Play window based on the device and screen metrics. Defaults to Same as Editor on phones and Side-by-side with Editor on tablets.
- Same as Editor will launch the Play window in the same window as the Editor.
- Side-by-side with Editor will launch the Play window side-by-side with the Editor window.
Note: Only available in the Android editor.
Overrides game embedding setting for all newly opened projects. If enabled, game embedding settings are not saved.
The window mode to use to display the project when starting the project from the editor.
Note: Game embedding is not available for "Force Maximized" or "Force Fullscreen".
The custom position to use when starting the project from the editor (in pixels from the top-left corner). Only effective if run/window_placement/rect is set to Custom Position.
If true, makes the caret blink according to text_editor/appearance/caret/caret_blink_interval. Disabling this setting can improve battery life on laptops if you spend long amounts of time in the script editor, since it will reduce the frequency at which the editor needs to be redrawn.
The interval at which the caret will blink (in seconds). See also text_editor/appearance/caret/caret_blink.
If true, highlights all occurrences of the currently selected text in the script editor. See also text_editor/theme/highlighting/word_highlighted_color.
If true, colors the background of the line the caret is currently on with text_editor/theme/highlighting/current_line_color.
The shape of the caret to use in the script editor. Line displays a vertical line to the left of the current character, whereas Block displays an outline over the current character.
If true, shows an info label listing available drop options when dragging an object into the script text editor.
If true, displays a colored button before any Color constructor in the script editor. Clicking on them allows the color to be modified through a color picker.
The column at which to display a subtle line as a line length guideline for scripts. This should generally be greater than text_editor/appearance/guidelines/line_length_guideline_soft_column.
The column at which to display a very subtle line as a line length guideline for scripts. This should generally be lower than text_editor/appearance/guidelines/line_length_guideline_hard_column.
If true, displays line length guidelines to help you keep line lengths in check. See also text_editor/appearance/guidelines/line_length_guideline_soft_column and text_editor/appearance/guidelines/line_length_guideline_hard_column.
If true, highlights type-safe lines by displaying their line number color with text_editor/theme/highlighting/safe_line_number_color instead of text_editor/theme/highlighting/line_number_color. Type-safe lines are lines of code where the type of all variables is known at compile-time. These type-safe lines may run faster thanks to typed instructions.
If true, displays a gutter at the left containing icons for methods with signal connections and for overridden methods.
If text_editor/appearance/lines/word_wrap is set to 1, sets text wrapping mode. To see how each mode behaves, see TextServer.AutowrapMode.
If true, displays the folding arrows next to indented code sections and allows code folding. If false, hides the folding arrows next to indented code sections and disallows code folding.
If true, wraps long lines over multiple lines to avoid horizontal scrolling. This is a display-only feature; it does not actually insert line breaks in your scripts.
If true, draws an overview of the script near the scroll bar. The minimap can be left-clicked to scroll directly to a location in an "absolute" manner.
The space to add between lines (in pixels). Greater line spacing can help improve readability at the cost of displaying fewer lines on screen. Negative values allow for even more compact text, but may look broken with certain fonts.
If true, automatically reloads scripts and text-based shaders in the editor when they have been modified and saved by external editors or tools and the editor regains focus. External changes can be discarded by using the Undo function after they've been loaded in the editor.
If false, a file conflict dialog will always be displayed when the editor regains focus. This dialog allows you to choose whether to keep local changes or discard them.
Note: Even when this setting is true, a file conflict dialog is still displayed in certain situations. For instance, it will display when the script editor has unsaved changes that the external editor did not account for.
If set to a value greater than 0, automatically saves the current script following the specified interval (in seconds). This can be used to prevent data loss if the editor crashes.
If true, converts indentation to match the script editor's indentation settings when saving a script. See also text_editor/behavior/indent/type.
If true, when dropping a Resource file to script editor while Ctrl is held, the resource will be preloaded with a UID. If false, the resource will be preloaded with a path.
When you hold Ctrl+Shift, the behavior is reversed.
If true, opening a scene automatically opens the script attached to the root node, or the topmost node if the root has no script.
If true, reopens scripts that were opened in the last session when the editor is reopened on a given project.
If true, trims all empty newlines after the final newline when saving a script. Final newlines refer to the empty newlines found at the end of files. Since these serve no practical purpose, they can and should be removed to make version control diffs less noisy.
If true, trims trailing whitespace when saving a script. Trailing whitespace refers to tab and space characters placed at the end of lines. Since these serve no practical purpose, they can and should be removed to make version control diffs less noisy.
If true, copying or cutting without a selection is performed on all lines with a caret. Otherwise, copy and cut require a selection.
When using tab indentation, determines the length of each tab. When using space indentation, determines how many spaces are inserted when pressing Tab and when automatic indentation is performed.
The indentation style to use (tabs or spaces).
Note: The GDScript style guide recommends using tabs for indentation. It is advised to change this setting only if you need to work on a project that currently uses spaces for indentation.
If true, uses StringName instead of String when appropriate for code autocompletion.
If true, automatically adds GDScript static typing (such as -> void and : int) in many situations where it's possible to, including when:
- Accepting a suggestion from code autocompletion;
- Creating a new script from a template;
- Connecting signals from the Signals dock;
- Creating variables prefixed with @onready, by dropping nodes from the Scene dock into the script editor while holding Ctrl.
If true, automatically inserts the matching closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when pressing Backspace on the opening brace. This includes brackets ((), [], {}), string quotation marks ('', ""), and comments (/**/) if the language supports it.
The delay in seconds after which autocompletion suggestions should be displayed when the user stops typing.
If true, code completion will be triggered automatically after text_editor/completion/code_complete_delay. Even if false, code completion can be triggered manually with the ui_text_completion_query action (by default Ctrl + Space or Cmd + Space on macOS).
If true enables the coloring for some items in the autocompletion suggestions, like vector components.
If true, provides autocompletion suggestions for file paths in methods such as load() and preload().
The delay in seconds after which the script editor should check for errors when the user stops typing.
The delay used instead of text_editor/completion/idle_parse_delay, when the parser has found errors. A lower value should feel more responsive while fixing code, but may cause notable stuttering and increase CPU usage.
If true, the code completion tooltip will appear below the current line unless there is no space on screen below the current line. If false, the code completion tooltip will appear above the current line.
If true, performs string autocompletion with single quotes. If false, performs string autocompletion with double quotes (which matches the GDScript style guide).
The command-line arguments to pass to the external text editor that is run when text_editor/external/use_external_editor is true. See also text_editor/external/exec_path.
The path to the text editor executable used to edit text files if text_editor/external/use_external_editor is true.
If true, uses an external editor instead of the built-in Script Editor. See also text_editor/external/exec_path and text_editor/external/exec_flags.
Controls which multi-line code blocks should be displayed in the editor help. This setting does not affect single-line code literals in the editor help.
If true, displays a table of contents at the left of the editor help (at the location where the members overview would appear when editing a script).
If true, class reference pages are grouped together at the bottom of the Script Editor's script list.
If true, the scripts that are used by the current scene are highlighted in the Script Editor's script list.
Specifies how script paths should be displayed in Script Editor's script list. If using the "Name" option and some scripts share the same file name, more parts of their paths are revealed to avoid conflicts.
If true, the names of recently opened scripts in the Script Editor are highlighted with the accent color, with its intensity based on how recently they were opened.
How many script names can be highlighted at most, if text_editor/script_list/script_temperature_enabled is true. Scripts older than this value use the default font color.
If true, displays an overview of the current script's member functions at the left of the script editor. See also text_editor/script_list/sort_members_outline_alphabetically.
If true, sorts the members outline (located at the left of the script editor) using alphabetical order. If false, sorts the members outline depending on the order in which members are found in the script.
Note: Only effective if text_editor/script_list/show_members_overview is true.
The syntax theme to use in the script editor.
You can save your own syntax theme from your current settings by using File > Theme > Save As... at the top of the script editor. The syntax theme will then be available locally in the list of color themes.
You can find additional syntax themes to install in the godot-syntax-themes repository.
The script editor's background color. If set to a translucent color, the editor theme's base color will be visible behind.
The script editor's brace mismatch color. Used when the caret is currently on a mismatched brace, parenthesis or bracket character.
The script editor's caret background color.
Note: This setting has no effect as it's currently unused.
The script editor's comment color.
Note: In GDScript, unlike Python, multiline strings are not considered to be comments, and will use the string highlighting color instead.
The script editor's critical comment marker text color. These markers are determined by text_editor/theme/highlighting/comment_markers/critical_list.
A comma-separated list of case-sensitive words to highlight in comments. The text will be highlighted in the script editor with the text_editor/theme/highlighting/comment_markers/critical_color color. These must not include spaces or symbols or they will not be highlighted.
Note: This is only implemented in the GDScript syntax highlighter.
The script editor's notice comment marker text color. These markers are determined by text_editor/theme/highlighting/comment_markers/notice_list.
A comma-separated list of case-sensitive words to highlight in comments. The text will be highlighted in the script editor with the text_editor/theme/highlighting/comment_markers/notice_color color. These must not include spaces or symbols or they will not be highlighted.
Note: This is only implemented in the GDScript syntax highlighter.
The script editor's warning comment marker text color. These markers are determined by text_editor/theme/highlighting/comment_markers/warning_list.
A comma-separated list of case-sensitive words to highlight in comments. The text will be highlighted in the script editor with the text_editor/theme/highlighting/comment_markers/warning_color color. These must not include spaces or symbols or they will not be highlighted.
Note: This is only implemented in the GDScript syntax highlighter.
The script editor's autocompletion box background color to highlight existing characters in the completion results. This should be a translucent color so that text_editor/theme/highlighting/completion_selected_color can be seen behind.
The script editor's background color for the line the caret is currently on. This should be set to a translucent color so that it can display on top of other line color modifiers such as text_editor/theme/highlighting/mark_color.
The script editor's documentation comment color. In GDScript, this is used for comments starting with ##. In C#, this is used for comments starting with /// or /**.
The script editor's function call color.
Note: When using the GDScript syntax highlighter, this is only used when calling some functions since function definitions and global functions have their own colors text_editor/theme/highlighting/gdscript/function_definition_color and text_editor/theme/highlighting/gdscript/global_function_color.
The GDScript syntax highlighter text color for function definitions (e.g. the _ready in func _ready():).
The GDScript syntax highlighter text color for global functions, such as the ones in @GlobalScope (e.g. preload()).
The GDScript syntax highlighter text color for NodePath literals (e.g. ^"position:x").
The GDScript syntax highlighter text color for node reference literals (e.g. $"Sprite" and %"Sprite"]).
The GDScript syntax highlighter text color for StringName literals (e.g. &"example").
The script editor's non-control flow keyword color (used for keywords like var, func, extends, ...).
The script editor's color for the line length guideline. The "hard" line length guideline will be drawn with this color, whereas the "soft" line length guideline will be drawn with half of its opacity.
The script editor's color for line numbers. See also text_editor/theme/highlighting/safe_line_number_color.
The script editor's background color for lines with errors. This should be set to a translucent color so that it can display on top of other line color modifiers such as text_editor/theme/highlighting/current_line_color.
The script editor's color for member variables on objects (e.g. self.some_property).
Note: This color is not used for local variable declaration and access.
The script editor's color for type-safe line numbers. See also text_editor/theme/highlighting/line_number_color.
Note: Only displayed if text_editor/appearance/gutters/highlight_type_safe_lines is true.
The script editor's color for the border of search results. This border helps bring further attention to the search result. Set this color's opacity to 0 to disable the border.
The script editor's color for string placeholders, such as %s and {_}. Refer to the GDScript format strings documentation for more details.
Note: Only the default {_} placeholder patterns are highlighted for the String.format() method. Custom patterns still appear as plain strings.
The script editor's background color for text. This should be set to a translucent color so that it can display on top of other line color modifiers such as text_editor/theme/highlighting/current_line_color.
The script editor's background color for lines with warnings. This should be set to a translucent color so that it can display on top of other line color modifiers such as text_editor/theme/highlighting/current_line_color.
The script editor's color for words highlighted by selecting them. Only visible if text_editor/appearance/caret/highlight_all_occurrences is true.
Adds a custom property info to a property. The dictionary must contain:
- name: String (the name of the property)
- type: int (see Variant.Type)
- optionally hint: int (see PropertyHint) and hint_string: String
var settings = EditorInterface.get_editor_settings()
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"
}
settings.add_property_info(property_info)Adds a shortcut whose path is specified by path.
The path determines how the shortcut is organized and displayed in the editor's shortcut settings. The path format affects the display as follows:
- "name" (no slash): Creates a category named name with the shortcut displayed as name.
- "category/name" (single slash): Displays as name in the category section.
- "category/name/extra" (multiple slashes): Extra path components are ignored, so this behaves the same as "category/name".
Note: Shortcuts are only saved to the editor settings if they differ from their original/default state. This means empty shortcuts that were originally empty will not persist between editor sessions and must be re-added. If a shortcut with the same path already exists, this method will update it with the new shortcut instead of creating a duplicate.
# Add a custom shortcut for a plugin action.
var my_shortcut = Shortcut.new()
var input_event = InputEventKey.new()
input_event.keycode = KEY_F5
input_event.ctrl_pressed = true
my_shortcut.events.append(input_event)
# This will appear under the "My Plugin" category as "Reload Data".
EditorInterface.get_editor_settings().add_shortcut("my_plugin/reload_data", my_shortcut)
# This will appear under the "Test Action" category as "Test Action".
EditorInterface.get_editor_settings().add_shortcut("test_action", my_shortcut)Checks if any settings with the prefix setting_prefix exist in the set of changed settings. See also get_changed_settings().
Gets an array of the settings which have been changed since the last save. Note that internally changed_settings is cleared after a successful save, so generally the most appropriate place to use this method is when processing NOTIFICATION_EDITOR_SETTINGS_CHANGED.
Returns project-specific metadata for the section and key specified. If the metadata doesn't exist, default will be returned instead. See also set_project_metadata().
Returns the value of the setting specified by name. This is equivalent to using Object.get() on the EditorSettings instance.
Returns the shortcut specified by path. Tries to find a built-in action if no shortcut with the provided path is found in the shortcut list. If found, adds it to the list and returns it, otherwise returns null.
Returns true if the shortcut specified by path matches the event specified by event, false otherwise.
Marks the passed editor setting as being changed, see get_changed_settings(). Only settings which exist (see has_setting()) will be accepted.
Sets the initial value of the setting specified by name to value. This is used to provide a value for the Revert button in the Editor Settings. If update_current is true, the setting is reset to value as well.
Sets project-specific metadata with the section, key and data specified. This metadata is stored outside the project folder and therefore won't be checked into version control. See also get_project_metadata().
Sets the value of the setting specified by name. This is equivalent to using Object.set() on the EditorSettings instance.