EditorInterface

Inherits: Node < Object Godot editor’s interface.

Description

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 true, enables distraction-free mode which hides side docks to increase the space available for the main view.

    Method Descriptions

  • edit_node ( Node node ) Node. The node will be also selected if it’s inside the scene tree.
  • edit_resource ( Resource resource ) Resource. If the resource is a Script you can also edit it with edit_script to specify the line and column position.
  • edit_script ( Script script, int line=-1, int column=0, bool grab_focus=true ) 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.
  • String get_current_path ( ) const FileSystemDock.
  • Node get_edited_scene_root ( ) Node.
  • float get_editor_scale ( ) const 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 ( ) EditorSettings instance.
  • Control get_editor_viewport ( ) Returns the main editor control. Use this as a parent for main screens. Note: This returns the main editor control containing the whole editor, not the 2D or 3D viewports specifically. Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
  • FileSystemDock get_file_system_dock ( ) 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 EditorInspector instance. Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
  • Array get_open_scenes ( ) const 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 ( ) EditorFileSystem instance.
  • EditorResourcePreview get_resource_previewer ( ) EditorResourcePreview instance.
  • ScriptEditor get_script_editor ( ) ScriptEditor instance. Warning: Removing and freeing this node will render a part of the editor useless and may cause a crash.
  • String get_selected_path ( ) const FileSystemDock. If a file is selected, its base directory will be returned using String.get_base_dir instead.
  • EditorSelection get_selection ( ) EditorSelection instance.
  • inspect_object ( Object object, String for_property=””, bool inspector_only=false ) object in the editor’s Inspector dock. If inspector_only is true, plugins will not attempt to edit object.
  • bool is_playing_scene ( ) const true if a scene is currently being played, false otherwise. Paused scenes are considered as being played.
  • bool is_plugin_enabled ( String plugin ) const true if the specified plugin is enabled. The plugin name is the same as its directory name.
  • Array make_mesh_previews ( Array meshes, int preview_size ) Array of Textures.
  • open_scene_from_path ( String scene_filepath ) Opens the scene at the given path.
  • play_current_scene ( ) Plays the currently active scene.
  • play_custom_scene ( String scene_filepath ) Plays the scene specified by its filepath.
  • play_main_scene ( ) Plays the main scene.
  • reload_scene_from_path ( String scene_filepath ) Reloads the scene at the given path.
  • Error save_scene ( ) OK or ERR_CANT_CREATE (see @GlobalScope constants).
  • save_scene_as ( String path, bool with_preview=true ) path.
  • select_file ( String file ) file, in the FileSystem dock.
  • set_main_screen_editor ( String name ) name. name must match the text of the tab in question exactly (2D, 3D, Script, AssetLib).
  • set_plugin_enabled ( String plugin, bool enabled ) Sets the enabled status of a plugin. The plugin name is the same as its directory name.
  • stop_playing_scene ( ) Stops the scene that is currently playing.