Base script that can be used to add extension functions to the editor.
|void||_run ( ) virtual|
|void||add_root_node ( Node node )|
|EditorInterface||get_editor_interface ( )|
|Node||get_scene ( )|
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.
tool 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.
- void _run ( ) virtual
This method is executed by the Editor when File > Run is used.
- void add_root_node ( Node node )
node as a child of the root node in the editor context.
Warning: The implementation of this method is currently disabled.
- EditorInterface get_editor_interface ( )
Returns the EditorInterface singleton instance.
- Node get_scene ( )
Returns the Editor’s currently active scene.