ScriptEditor

Documentation

Overview

Package ScriptEditor provides methods for working with ScriptEditor object instances.

Index

• type Advanced
• type Any
• 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) GetBreakpoints() []string
  • func (self Instance) GetCurrentEditor() [1]gdclass.ScriptEditorBase
  • func (self Instance) GetCurrentScript() [1]gdclass.Script
  • func (self Instance) GetOpenScriptEditors() [][1]gdclass.ScriptEditorBase
  • func (self Instance) GetOpenScripts() [][1]gdclass.Script
  • func (self Instance) GotoHelp(topic string)
  • func (self Instance) GotoLine(line_number int)
  • func (self Instance) OnEditorScriptChanged(cb func(script [1]gdclass.Script))
  • func (self Instance) OnScriptClose(cb func(script [1]gdclass.Script))
  • func (self Instance) OpenScriptCreateDialog(base_name string, base_path string)
  • func (self Instance) RegisterSyntaxHighlighter(syntax_highlighter [1]gdclass.EditorSyntaxHighlighter)
  • func (self Instance) UnregisterSyntaxHighlighter(syntax_highlighter [1]gdclass.EditorSyntaxHighlighter)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) UpdateDocsFromScript(script [1]gdclass.Script)
  • 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 Instance

type Instance [1]gdclass.ScriptEditor

Godot editor's script editor. [b]Note:[/b] This class shouldn't be instantiated directly. Instead, access the singleton using [method EditorInterface.get_script_editor].

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) GetBreakpoints

func (self Instance) GetBreakpoints() []string

Returns array of breakpoints.

func (Instance) GetCurrentEditor

func (self Instance) GetCurrentEditor() [1]gdclass.ScriptEditorBase

Returns the [ScriptEditorBase] object that the user is currently editing.

func (Instance) GetCurrentScript

func (self Instance) GetCurrentScript() [1]gdclass.Script

Returns a [Script] that is currently active in editor.

func (Instance) GetOpenScriptEditors

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

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

func (Instance) GetOpenScripts

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

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 [param topic] is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused. The supported [param topic] formats include [code]class_name:class[/code], [code]class_method:class:method[/code], [code]class_constant:class:constant[/code], [code]class_signal:class:signal[/code], [code]class_annotation:class:@annotation[/code], [code]class_property:class:property[/code], and [code]class_theme_item:class:item[/code], where [code]class[/code] is the class name, [code]method[/code] is the method name, [code]constant[/code] is the constant name, [code]signal[/code] is the signal name, [code]annotation[/code] is the annotation name, [code]property[/code] is the property name, and [code]item[/code] is the theme item. [codeblock] # 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 [/codeblock]

func (Instance) GotoLine

func (self Instance) GotoLine(line_number int)

Goes to the specified line in the current script.

func (Instance) OnEditorScriptChanged

func (self Instance) OnEditorScriptChanged(cb func(script [1]gdclass.Script))

func (Instance) OnScriptClose

func (self Instance) OnScriptClose(cb func(script [1]gdclass.Script))

func (Instance) OpenScriptCreateDialog

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

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

func (Instance) RegisterSyntaxHighlighter

func (self Instance) RegisterSyntaxHighlighter(syntax_highlighter [1]gdclass.EditorSyntaxHighlighter)

Registers the [EditorSyntaxHighlighter] to the editor, the [EditorSyntaxHighlighter] will be available on all open scripts. [b]Note:[/b] Does not apply to scripts that are already opened.

func (Instance) UnregisterSyntaxHighlighter

func (self Instance) UnregisterSyntaxHighlighter(syntax_highlighter [1]gdclass.EditorSyntaxHighlighter)

Unregisters the [EditorSyntaxHighlighter] from the editor. [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) UpdateDocsFromScript

func (self Instance) UpdateDocsFromScript(script [1]gdclass.Script)

Updates the documentation for the given [param script] if the script's documentation is currently open. [b]Note:[/b] 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