Skip to content
Download
API reference

EditorScript

Inherits: Shared < Object

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

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 Gobu. For more complex additions, consider using EditorPlugins instead.

If a script extending this class also has a module name, it will be included in the editor’s command palette.

Note: Extending scripts need to have tool mode enabled.

Example: Running the following script prints “Hello from the Gobu Editor!”:

@tool
fn _run() void {
print("Hello from the Gobu Editor!")
}

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

ReturnsMethod
void_run()

void _run() virtual required

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