ScriptEditor

Documentation

Overview

Godot editor's script editor.

Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.GetScriptEditor.

Index

• type Advanced
• type Any
• type Extension
  • func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
  • func (self *Extension[T]) AsContainer() Container.Instance
  • func (self *Extension[T]) AsControl() Control.Instance
  • func (self *Extension[T]) AsNode() Node.Instance
  • func (self *Extension[T]) AsObject() [1]gd.Object
  • func (self *Extension[T]) AsPanelContainer() PanelContainer.Instance
  • func (self *Extension[T]) AsScriptEditor() Instance
• type ID
  • func (id ID) Instance() (Instance, bool)
• type Instance
  • func New() Instance
  • func (self Instance) AsCanvasItem() CanvasItem.Instance
  • func (self Instance) AsContainer() Container.Instance
  • func (self Instance) AsControl() Control.Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsPanelContainer() PanelContainer.Instance
  • func (self Instance) AsScriptEditor() Instance
  • func (self Instance) ClearDocsFromScript(script Script.Instance)
  • func (self Instance) GetBreakpoints() []string
  • func (self Instance) GetCurrentEditor() ScriptEditorBase.Instance
  • func (self Instance) GetCurrentScript() Script.Instance
  • func (self Instance) GetOpenScriptEditors() []ScriptEditorBase.Instance
  • func (self Instance) GetOpenScripts() []Script.Instance
  • func (self Instance) GotoHelp(topic string)
  • func (self Instance) GotoLine(line_number int)
  • func (self Instance) ID() ID
  • func (self Instance) OnEditorScriptChanged(cb func(script Script.Instance), flags ...Signal.Flags)
  • func (self Instance) OnScriptClose(cb func(script Script.Instance), flags ...Signal.Flags)
  • func (self Instance) OpenScriptCreateDialog(base_name string, base_path string)
  • func (self Instance) RegisterSyntaxHighlighter(syntax_highlighter EditorSyntaxHighlighter.Instance)
  • func (self *Instance) SetObject(obj [1]gd.Object) bool
  • func (self Instance) UnregisterSyntaxHighlighter(syntax_highlighter EditorSyntaxHighlighter.Instance)
  • func (self Instance) UpdateDocsFromScript(script Script.Instance)
  • func (self Instance) Virtual(name string) reflect.Value

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 Any

type Any interface {
	gd.IsClass
	AsScriptEditor() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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

func (*Extension[T]) AsCanvasItem

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsContainer

func (self *Extension[T]) AsContainer() Container.Instance

func (*Extension[T]) AsControl

func (self *Extension[T]) AsControl() Control.Instance

func (*Extension[T]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsPanelContainer

func (self *Extension[T]) AsPanelContainer() PanelContainer.Instance

func (*Extension[T]) AsScriptEditor

func (self *Extension[T]) AsScriptEditor() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

type Instance [1]gdclass.ScriptEditor

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 New

func New() Instance

func (Instance) AsCanvasItem

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsContainer

func (self Instance) AsContainer() Container.Instance

func (Instance) AsControl

func (self Instance) AsControl() Control.Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPanelContainer

func (self Instance) AsPanelContainer() PanelContainer.Instance

func (Instance) AsScriptEditor

func (self Instance) AsScriptEditor() Instance

func (Instance) ClearDocsFromScript

func (self Instance) ClearDocsFromScript(script Script.Instance)

Removes the documentation for the given 'script'.

Note: This should be called whenever the script is changed to keep the open documentation state up to date.

func (Instance) GetBreakpoints

func (self Instance) GetBreakpoints() []string

Returns array of breakpoints.

func (Instance) GetCurrentEditor

func (self Instance) GetCurrentEditor() ScriptEditorBase.Instance

Returns the ScriptEditorBase object that the user is currently editing.

func (Instance) GetCurrentScript

func (self Instance) GetCurrentScript() Script.Instance

Returns a Script that is currently active in editor.

func (Instance) GetOpenScriptEditors

func (self Instance) GetOpenScriptEditors() []ScriptEditorBase.Instance

Returns an array with all ScriptEditorBase objects which are currently open in editor.

func (Instance) GetOpenScripts

func (self Instance) GetOpenScripts() []Script.Instance

Returns an array with all Script objects which are currently open in editor.

func (Instance) GotoHelp

func (self Instance) GotoHelp(topic string)

Opens help for the given topic. The 'topic' is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused.

The supported 'topic' formats include class_name:class, class_method:class:method, class_constant:class:constant, class_signal:class:signal, class_annotation:class:@annotation, class_property:class:property, and class_theme_item:class:item, where class is the class name, method is the method name, constant is the constant name, signal is the signal name, annotation is the annotation name, property is the property name, and item is the theme item.

var topics = []string{
	// Shows help for the Node class.
	"class_name:Node",
	// Shows help for the global min function.
	// Global objects are accessible in the GlobalScope namespace, shown here.
	"class_method:@GlobalScope:min",
	// Shows help for get_viewport in the Node class.
	"class_method:Node:get_viewport",
	// Shows help for the Input constant MOUSE_BUTTON_MIDDLE.
	"class_constant:Input:MOUSE_BUTTON_MIDDLE",
	// Shows help for the BaseButton signal pressed.
	"class_signal:BaseButton:pressed",
	// Shows help for the CanvasItem property visible.
	"class_property:CanvasItem:visible",
	// Shows help for the GDScript annotation export.
	// Annotations should be prefixed with the '@' symbol in the descriptor, as shown here.
	"class_annotation:@GDScript:@export",
	// Shows help for the GraphNode theme item named panel_selected.
	"class_theme_item:GraphNode:panel_selected",
}
for _, topic := range topics {
	scriptEditor.GotoHelp(topic)
}

func (Instance) GotoLine

func (self Instance) GotoLine(line_number int)

Goes to the specified line in the current script.

func (Instance) ID

func (self Instance) ID() ID

func (Instance) OnEditorScriptChanged

func (self Instance) OnEditorScriptChanged(cb func(script Script.Instance), flags ...Signal.Flags)

Emitted when user changed active script. Argument is a freshly activated Script.

func (Instance) OnScriptClose

func (self Instance) OnScriptClose(cb func(script Script.Instance), flags ...Signal.Flags)

Emitted when editor is about to close the active script. Argument is a Script that is going to be closed.

func (Instance) OpenScriptCreateDialog

func (self Instance) OpenScriptCreateDialog(base_name string, base_path string)

Opens the script create dialog. The script will extend 'base_name'. The file extension can be omitted from 'base_path'. It will be added based on the selected scripting language.

func (Instance) RegisterSyntaxHighlighter

func (self Instance) RegisterSyntaxHighlighter(syntax_highlighter EditorSyntaxHighlighter.Instance)

Registers the EditorSyntaxHighlighter to the editor, the EditorSyntaxHighlighter will be available on all open scripts.

Note: Does not apply to scripts that are already opened.

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) UnregisterSyntaxHighlighter

func (self Instance) UnregisterSyntaxHighlighter(syntax_highlighter EditorSyntaxHighlighter.Instance)

Unregisters the EditorSyntaxHighlighter from the editor.

Note: The EditorSyntaxHighlighter will still be applied to scripts that are already opened.

func (Instance) UpdateDocsFromScript

func (self Instance) UpdateDocsFromScript(script Script.Instance)

Updates the documentation for the given 'script'.

Note: This should be called whenever the script is changed to keep the open documentation state up to date.

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value