Documentation
¶
Overview ¶
Package ScriptEditor provides methods for working with ScriptEditor object instances.
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
- type 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() 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
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
func (*Extension[T]) AsCanvasItem ¶
func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance
func (*Extension[T]) AsContainer ¶
func (*Extension[T]) AsPanelContainer ¶
func (self *Extension[T]) AsPanelContainer() PanelContainer.Instance
func (*Extension[T]) AsScriptEditor ¶
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 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 (Instance) AsCanvasItem ¶
func (self Instance) AsCanvasItem() CanvasItem.Instance
func (Instance) AsContainer ¶
func (Instance) AsPanelContainer ¶
func (self Instance) AsPanelContainer() PanelContainer.Instance
func (Instance) AsScriptEditor ¶
func (Instance) GetBreakpoints ¶
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 ¶
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 ¶
Returns an array with all [Script] objects which are currently open in editor.
func (Instance) GotoHelp ¶
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) OnEditorScriptChanged ¶
func (Instance) OnScriptClose ¶
func (Instance) OpenScriptCreateDialog ¶
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 EditorSyntaxHighlighter.Instance)
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 EditorSyntaxHighlighter.Instance)
Unregisters the [EditorSyntaxHighlighter] from the editor. [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened.
func (Instance) UpdateDocsFromScript ¶
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.
Source Files