EditorScript

Inherits: Reference < Object

Category: Core

Brief Description

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

Methods

void _run ( ) virtual
void add_root_node ( Node node )
EditorInterface get_editor_interface ( )
Node get_scene ( )

Description

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 that extending scripts need to have tool mode enabled.

Example script:

tool
extends EditorScript

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

Note that 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.

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.