:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/ScriptEditor.xml. .. _class_ScriptEditor: ScriptEditor ============ **Inherits:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Godot editor's script editor. .. rst-class:: classref-introduction-group Description ----------- Godot editor's script editor. \ **Note:** This class shouldn't be instantiated directly. Instead, access the singleton using :ref:`EditorInterface.get_script_editor`. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptEditorBase` | :ref:`get_current_editor` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Script` | :ref:`get_current_script` **(** **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptEditorBase[]` | :ref:`get_open_script_editors` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Script[]` | :ref:`get_open_scripts` **(** **)** |const| | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`goto_line` **(** :ref:`int` line_number **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`open_script_create_dialog` **(** :ref:`String` base_name, :ref:`String` base_path **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`register_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`unregister_syntax_highlighter` **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** | +---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ScriptEditor_signal_editor_script_changed: .. rst-class:: classref-signal **editor_script_changed** **(** :ref:`Script` script **)** Emitted when user changed active script. Argument is a freshly activated :ref:`Script`. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_signal_script_close: .. rst-class:: classref-signal **script_close** **(** :ref:`Script` script **)** Emitted when editor is about to close the active script. Argument is a :ref:`Script` that is going to be closed. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ScriptEditor_method_get_current_editor: .. rst-class:: classref-method :ref:`ScriptEditorBase` **get_current_editor** **(** **)** |const| Returns the :ref:`ScriptEditorBase` object that the user is currently editing. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_current_script: .. rst-class:: classref-method :ref:`Script` **get_current_script** **(** **)** Returns a :ref:`Script` that is currently active in editor. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_open_script_editors: .. rst-class:: classref-method :ref:`ScriptEditorBase[]` **get_open_script_editors** **(** **)** |const| Returns an array with all :ref:`ScriptEditorBase` objects which are currently open in editor. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_open_scripts: .. rst-class:: classref-method :ref:`Script[]` **get_open_scripts** **(** **)** |const| Returns an array with all :ref:`Script` objects which are currently open in editor. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_goto_line: .. rst-class:: classref-method void **goto_line** **(** :ref:`int` line_number **)** Goes to the specified line in the current script. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_open_script_create_dialog: .. rst-class:: classref-method void **open_script_create_dialog** **(** :ref:`String` base_name, :ref:`String` base_path **)** 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. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_register_syntax_highlighter: .. rst-class:: classref-method void **register_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** Registers the :ref:`EditorSyntaxHighlighter` to the editor, the :ref:`EditorSyntaxHighlighter` will be available on all open scripts. \ **Note:** Does not apply to scripts that are already opened. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_unregister_syntax_highlighter: .. rst-class:: classref-method void **unregister_syntax_highlighter** **(** :ref:`EditorSyntaxHighlighter` syntax_highlighter **)** Unregisters the :ref:`EditorSyntaxHighlighter` from the editor. \ **Note:** The :ref:`EditorSyntaxHighlighter` will still be applied to scripts that are already opened. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`