EditorScript

Inherits: RefCounted < Object

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

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

Example script:

GDScriptC#

@tool
extends EditorScript
func _run():
    print("Hello from the Godot Editor!")

using Godot;
[Tool]
public partial class HelloEditor : EditorScript
{
    public override void _Run()
    {
        GD.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.

Note: EditorScript is RefCounted, meaning it is destroyed when nothing references it. This can cause errors during asynchronous operations if there are no references to the script.

Methods

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.

EditorInterface get_editor_interface ( ) const

Returns the EditorInterface singleton instance.

Deprecated. EditorInterface is a global singleton and can be accessed directly by its name.

Node get_scene ( ) const

Returns the Editor’s currently active scene.

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.