Inherits: Reference < Object

Base script that can be used to add extension functions to the editor.


Scripts extending this class and implementing its _run method can be executed from the Script Editor's File > Run menu option (or by pressing Ctrl+Shift+X) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using EditorPlugins instead.

Note: Extending scripts need to have tool mode enabled.

Example script:

extends EditorScript

func _run():
    print("Hello from the Godot Editor!")

Note: The script is run in the Editor context, which means the output is visible in the console window started with the Editor (stdout) instead of the usual Godot Output dock.



_run ( ) virtual


add_root_node ( Node node )


get_editor_interface ( )


get_scene ( )

Method Descriptions

  • void _run ( ) virtual

This method is executed by the Editor when File > Run is used.

  • void add_root_node ( Node node )

Adds node as a child of the root node in the editor context.

Warning: The implementation of this method is currently disabled.

Returns the EditorInterface singleton instance.

  • Node get_scene ( )

Returns the Editor's currently active scene.