EditorInterface

Inherits: Node < Object

Redot editor's interface.

Description

EditorInterface gives you control over Redot 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

bool	distraction_free_mode

Methods

void	edit_node ( Node node )
void	edit_resource ( Resource resource )
void	edit_script ( Script script, int line=-1, int column=0, bool grab_focus=true )
Control	get_base_control ( )
String	get_current_path ( ) const
Node	get_edited_scene_root ( )
float	get_editor_scale ( ) const
EditorSettings	get_editor_settings ( )
Control	get_editor_viewport ( )
FileSystemDock	get_file_system_dock ( )
EditorInspector	get_inspector ( ) const
Array	get_open_scenes ( ) const
String	get_playing_scene ( ) const
EditorFileSystem	get_resource_filesystem ( )
EditorResourcePreview	get_resource_previewer ( )
ScriptEditor	get_script_editor ( )
String	get_selected_path ( ) const
EditorSelection	get_selection ( )
void	inspect_object ( Object object, String for_property="", bool inspector_only=false )
bool	is_playing_scene ( ) const
bool	is_plugin_enabled ( String plugin ) const
Array	make_mesh_previews ( Array meshes, int preview_size )
void	open_scene_from_path ( String scene_filepath )
void	play_current_scene ( )
void	play_custom_scene ( String scene_filepath )
void	play_main_scene ( )
void	reload_scene_from_path ( String scene_filepath )
Error	save_scene ( )
void	save_scene_as ( String path, bool with_preview=true )
void	select_file ( String file )
void	set_main_screen_editor ( String name )
void	set_plugin_enabled ( String plugin, bool enabled )
void	stop_playing_scene ( )

---

Property Descriptions

bool distraction_free_mode

• void set_distraction_free_mode ( bool value )

• bool is_distraction_free_mode_enabled ( )

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 Redot 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

Returns the current path being viewed in the FileSystemDock.

---

Node get_edited_scene_root ( )

Returns the edited (current) scene's root Node.

---

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.

---

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 ( )

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.

---

Array 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.

---

String get_selected_path ( ) const

Returns the path of the directory currently selected in the FileSystemDock. If a file is selected, its base directory will be returned using String.get_base_dir instead.

---

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_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.

---

Array make_mesh_previews ( Array meshes, int preview_size )

Returns mesh previews rendered at the given size as an Array of Textures.

---

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.

---

Error save_scene ( )

Saves the scene. Returns either OK or ERR_CANT_CREATE (see @GlobalScope constants).

---

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_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.