Struct EditorScript
Base script that can be used to add extension functions to the editor.
struct EditorScript
;
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:
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
| Name | Description |
|---|---|
_run
|
This method is executed by the Editor when File > Run is used. |
addRootNode
|
Adds node as a child of the root node in the editor context.
Warning: The implementation of this method is currently disabled.
|
getEditorInterface
|
Returns the EditorInterface singleton instance.
|
getScene
|
Returns the Editor's currently active scene. |