Documentation
¶
Overview ¶
Scripts extending this class and implementing its [Interface.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 [graphics.gd/classdb/EditorPlugin]s instead.
If a script extending this class also has a global class 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 Godot Editor!":
package main
import (
"fmt"
"graphics.gd/classdb/EditorScript"
)
type HelloEditor struct {
EditorScript.Extension[HelloEditor]
}
func (h *HelloEditor) Run() {
fmt.Println("Hello from the Godot Editor!")
}
Note: EditorScript is graphics.gd/classdb/RefCounted, meaning it is destroyed when nothing references it. This can cause errors during asynchronous operations if there are no references to the script.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Implementation
- type Instance
- func (self Instance) AddRootNode(node Node.Instance)
- func (self Instance) AsEditorScript() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) GetEditorInterface() EditorInterface.Instance
- func (self Instance) GetScene() Node.Instance
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
- type Interface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.
func (*Extension[T]) AsEditorScript ¶
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Implementation ¶
type Implementation = implementation
Implementation implements Interface with empty methods.
type Instance ¶
type Instance [1]gdclass.EditorScript
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AddRootNode ¶
Makes 'node' root of the currently opened scene. Only works if the scene is empty. If the 'node' is a scene instance, an inheriting scene will be created.
func (Instance) AsEditorScript ¶
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) GetEditorInterface ¶
func (self Instance) GetEditorInterface() EditorInterface.Instance
Returns the graphics.gd/classdb/EditorInterface singleton instance.
func (Instance) GetScene ¶
Returns the edited (current) scene's root graphics.gd/classdb/Node. Equivalent of graphics.gd/classdb/EditorInterface.GetEditedSceneRoot.
Source Files