:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/ScriptEditorBase.xml. .. _class_ScriptEditorBase: ScriptEditorBase ================ **Inherits:** :ref:`VBoxContainer` **<** :ref:`BoxContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Base editor for editing scripts in the :ref:`ScriptEditor`. .. rst-class:: classref-introduction-group Description ----------- Base editor for editing scripts in the :ref:`ScriptEditor`. This does not include documentation items. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_syntax_highlighter`\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Control` | :ref:`get_base_editor`\ (\ ) |const| | +-------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_ScriptEditorBase_signal_edited_script_changed: .. rst-class:: classref-signal **edited_script_changed**\ (\ ) :ref:`🔗` Emitted after script validation. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_go_to_help: .. rst-class:: classref-signal **go_to_help**\ (\ what\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests a specific documentation page. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_go_to_method: .. rst-class:: classref-signal **go_to_method**\ (\ script\: :ref:`Object`, method\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests to view a specific method of a script, similar to :ref:`request_open_script_at_line`. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_name_changed: .. rst-class:: classref-signal **name_changed**\ (\ ) :ref:`🔗` Emitted after script validation or when the edited resource has changed. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_replace_in_files_requested: .. rst-class:: classref-signal **replace_in_files_requested**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Emitted when the user request to find and replace text in the file system. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_request_help: .. rst-class:: classref-signal **request_help**\ (\ topic\: :ref:`String`\ ) :ref:`🔗` Emitted when the user requests contextual help. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_request_open_script_at_line: .. rst-class:: classref-signal **request_open_script_at_line**\ (\ script\: :ref:`Object`, line\: :ref:`int`\ ) :ref:`🔗` Emitted when the user requests to view a specific line of a script, similar to :ref:`go_to_method`. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_request_save_history: .. rst-class:: classref-signal **request_save_history**\ (\ ) :ref:`🔗` Emitted when the user contextual goto and the item is in the same script. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_request_save_previous_state: .. rst-class:: classref-signal **request_save_previous_state**\ (\ state\: :ref:`Dictionary`\ ) :ref:`🔗` Emitted when the user changes current script or moves caret by 10 or more columns within the same script. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_signal_search_in_files_requested: .. rst-class:: classref-signal **search_in_files_requested**\ (\ text\: :ref:`String`\ ) :ref:`🔗` Emitted when the user request to search text in the file system. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_ScriptEditorBase_method_add_syntax_highlighter: .. rst-class:: classref-method |void| **add_syntax_highlighter**\ (\ highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Adds a :ref:`EditorSyntaxHighlighter` to the open script. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditorBase_method_get_base_editor: .. rst-class:: classref-method :ref:`Control` **get_base_editor**\ (\ ) |const| :ref:`🔗` Returns the underlying :ref:`Control` used for editing scripts. For text scripts, this is a :ref:`CodeEdit`. .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`