Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

ScriptEditor

Inherits: PanelContainer < Container < Control < CanvasItem < Node < Object

Godot editor's script editor.

Description

Godot editor's script editor.

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

Methods

ScriptEditorBase

get_current_editor() const

Script

get_current_script()

Array[ScriptEditorBase]

get_open_script_editors() const

Array[Script]

get_open_scripts() const

void

goto_line(line_number: int)

void

open_script_create_dialog(base_name: String, base_path: String)

void

register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)

void

unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)


Signals

editor_script_changed(script: Script)

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


script_close(script: Script)

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


Method Descriptions

ScriptEditorBase get_current_editor() const

Returns the ScriptEditorBase object that the user is currently editing.


Script get_current_script()

Returns a Script that is currently active in editor.


Array[ScriptEditorBase] get_open_script_editors() const

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


Array[Script] get_open_scripts() const

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


void goto_line(line_number: int)

Goes to the specified line in the current script.


void open_script_create_dialog(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.


void register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)

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.


void unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)

Unregisters the EditorSyntaxHighlighter from the editor.

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


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.