Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
EditorInterface¶
Inherits: Object
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 directly by its name.
var editor_settings = EditorInterface.get_editor_settings()
// In C# you can access it via the static Singleton property.
EditorSettings settings = EditorInterface.Singleton.GetEditorSettings();
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.
bool movie_maker_enabled
If true
, the Movie Maker mode is enabled in the editor. See MovieWriter for more information.
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 ( ) const
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_feature_profile ( ) const
Returns the name of the currently activated feature profile. If the default profile is currently active, an empty string is returned instead.
In order to get a reference to the EditorFeatureProfile, you must load the feature profile using EditorFeatureProfile.load_from_file.
Note: Feature profiles created via the user interface are loaded from the feature_profiles
directory, as a file with the .profile
extension. The editor configuration folder can be found by using EditorPaths.get_config_dir.
String get_current_path ( ) const
Returns the current