EditorScript

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 Godot. For more complex additions, consider using EditorPlugins instead. Note: Extending scripts need to have tool mode enabled. Example script:

More...

@GodotBaseClass

struct EditorScript {

package

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(EditorScript other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static EditorScript _new();

void _run();

void addRootNode(Node node);

EditorInterface getEditorInterface();

Node getScene();

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Functions

_run void _run(): This method is executed by the Editor when File > Run is used.
addRootNode void addRootNode(Node node): Adds node as a child of the root node in the editor context. Warning: The implementation of this method is currently disabled.
getEditorInterface EditorInterface getEditorInterface(): Returns the EditorInterface singleton instance.
getScene Node getScene(): Returns the Editor's currently active scene.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(EditorScript other)
opEquals bool opEquals(typeof(null) n)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Static functions

_new EditorScript _new(): Construct a new instance of EditorScript. Note: use memnew!EditorScript instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Detailed Description

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.

EditorScript

Members

Aliases

Functions

Mixins

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Detailed Description

Meta

Source

EditorScript

From mixin baseCasts

From `mixin baseCasts`