Up to date
This page is up to date for Godot 4.0.
If you still find outdated information, please open an issue.
EditorInterface¶
Godot editor's interface.
Description¶
EditorInterface gives you control over Godot editor's window. It allows customizing the window, saving and (re-)loading scenes, rendering mesh previews, inspecting and editing resources and objects, and provides access to EditorSettings, EditorFileSystem, EditorResourcePreview, ScriptEditor, the editor viewport, and information about scenes.
Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorPlugin.get_editor_interface.
Properties¶
Methods¶
Property Descriptions¶
bool distraction_free_mode
If true, enables distraction-free mode which hides side docks to increase the space available for the main view.
Method Descriptions¶
void edit_node ( Node node )
Edits the given Node. The node will be also selected if it's inside the scene tree.
void edit_resource ( Resource resource )
Edits the given Resource. If the resource is a Script you can also edit it with edit_script to specify the line and column position.
void edit_script ( Script script, int line=-1, int column=0, bool grab_focus=true )
Edits the given Script. The line and column on which to open the script can also be specified. The script will be open with the user-configured editor for the script's language which may be an external editor.
Control get_base_control ( )
Returns the main container of Godot editor's window. For example, you can use it to retrieve the size of the container and place your controls accordingly.
Warning: Removing and freeing this node will render the editor useless and may cause a crash.
EditorCommandPalette get_command_palette ( ) const
Returns the editor's EditorCommandPalette instance.
Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
String get_current_directory ( ) const
Returns the current directory being viewed in the FileSystemDock. If a file is selected, its base directory will be returned using String.get_base_dir instead.
String get_current_path ( ) const
Returns the current path being viewed in the FileSystemDock.
Node get_edited_scene_root ( )
Returns the edited (current) scene's root Node.
VBoxContainer get_editor_main_screen ( )
Returns the editor control responsible for main screen plugins and tools. Use it with plugins that implement EditorPlugin._has_main_screen.
Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
EditorPaths get_editor_paths ( )
Returns the EditorPaths singleton.
float get_editor_scale ( ) const
Returns the actual scale of the editor UI (1.0 being 100% scale). This can be used to adjust position and dimensions of the UI added by plugins.
Note: This value is set via the interface/editor/display_scale and interface/editor/custom_display_scale editor settings. Editor must be restarted for changes to be properly applied.
EditorSettings get_editor_settings ( )
Returns the editor's EditorSettings instance.
FileSystemDock get_file_system_dock ( )
Returns the editor's FileSystemDock instance.
Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
EditorInspector get_inspector ( ) const
Returns the editor's EditorInspector instance.
Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
PackedStringArray get_open_scenes ( ) const
Returns an Array with the file paths of the currently opened scenes.
String get_playing_scene ( ) const
Returns the name of the scene that is being played. If no scene is currently being played, returns an empty string.
EditorFileSystem get_resource_filesystem ( )
Returns the editor's EditorFileSystem instance.
EditorResourcePreview get_resource_previewer ( )
Returns the editor's EditorResourcePreview instance.
ScriptEditor get_script_editor ( )
Returns the editor's ScriptEditor instance.
Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
PackedStringArray get_selected_paths ( ) const
Returns an array containing the paths of the currently selected files (and directories) in the FileSystemDock.
EditorSelection get_selection ( )
Returns the editor's EditorSelection instance.
void inspect_object ( Object object, String for_property="", bool inspector_only=false )
Shows the given property on the given object in the editor's Inspector dock. If inspector_only is true, plugins will not attempt to edit object.
bool is_movie_maker_enabled ( ) const
Returns true if Movie Maker mode is enabled in the editor. See also set_movie_maker_enabled. See MovieWriter for more information.
bool is_playing_scene ( ) const
Returns true if a scene is currently being played, false otherwise. Paused scenes are considered as being played.
bool is_plugin_enabled ( String plugin ) const
Returns true if the specified plugin is enabled. The plugin name is the same as its directory name.
Texture2D[] make_mesh_previews ( Mesh[] meshes, int preview_size )
Returns mesh previews rendered at the given size as an Array of Texture2Ds.
void open_scene_from_path ( String scene_filepath )
Opens the scene at the given path.
void play_current_scene ( )
Plays the currently active scene.
void play_custom_scene ( String scene_filepath )
Plays the scene specified by its filepath.
void play_main_scene ( )
Plays the main scene.
void reload_scene_from_path ( String scene_filepath )
Reloads the scene at the given path.
void restart_editor ( bool save=true )
Restarts the editor. This closes the editor and then opens the same project. If save is true, the project will be saved before restarting.
Error save_scene ( )
Saves the scene. Returns either @GlobalScope.OK or @GlobalScope.ERR_CANT_CREATE.
void save_scene_as ( String path, bool with_preview=true )
Saves the scene as a file at path.
void select_file ( String file )
Selects the file, with the path provided by file, in the FileSystem dock.
void set_main_screen_editor ( String name )
Sets the editor's current main screen to the one specified in name. name must match the text of the tab in question exactly (2D, 3D, Script, AssetLib).
void set_movie_maker_enabled ( bool enabled )
Sets whether Movie Maker mode is enabled in the editor. See also is_movie_maker_enabled. See MovieWriter for more information.
void set_plugin_enabled ( String plugin, bool enabled )
Sets the enabled status of a plugin. The plugin name is the same as its directory name.
void stop_playing_scene ( )
Stops the scene that is currently playing.