Skip to content

Latest commit

 

History

History
82 lines (49 loc) · 3.38 KB

class_editorscript.rst

File metadata and controls

82 lines (49 loc) · 3.38 KB
github_url:hide

EditorScript

Inherits: :ref:`Reference<class_Reference>` < :ref:`Object<class_Object>`

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

Description

Scripts extending this class and implementing its :ref:`_run<class_EditorScript_method__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 :ref:`EditorPlugin<class_EditorPlugin>`s instead.

Note: Extending scripts need to have tool mode enabled.

Example script:

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.

Methods

void :ref:`_run<class_EditorScript_method__run>` ( ) virtual
void :ref:`add_root_node<class_EditorScript_method_add_root_node>` ( :ref:`Node<class_Node>` node )
:ref:`EditorInterface<class_EditorInterface>` :ref:`get_editor_interface<class_EditorScript_method_get_editor_interface>` ( )
:ref:`Node<class_Node>` :ref:`get_scene<class_EditorScript_method_get_scene>` ( )

Method Descriptions

  • void _run ( ) virtual

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

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

Warning: The implementation of this method is currently disabled.

Returns the :ref:`EditorInterface<class_EditorInterface>` singleton instance.

Returns the Editor's currently active scene.