mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
187 lines
6.1 KiB
ReStructuredText
187 lines
6.1 KiB
ReStructuredText
: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/ScriptEditorBase.xml.
|
|
|
|
.. _class_ScriptEditorBase:
|
|
|
|
ScriptEditorBase
|
|
================
|
|
|
|
**Inherits:** :ref:`VBoxContainer<class_VBoxContainer>` **<** :ref:`BoxContainer<class_BoxContainer>` **<** :ref:`Container<class_Container>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
Base editor for editing scripts in the :ref:`ScriptEditor<class_ScriptEditor>`.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Base editor for editing scripts in the :ref:`ScriptEditor<class_ScriptEditor>`. This does not include documentation items.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`add_syntax_highlighter<class_ScriptEditorBase_method_add_syntax_highlighter>` **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)** |
|
|
+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Control<class_Control>` | :ref:`get_base_editor<class_ScriptEditorBase_method_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** **(** **)**
|
|
|
|
Emitted after script validation.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ScriptEditorBase_signal_go_to_help:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**go_to_help** **(** :ref:`String<class_String>` what **)**
|
|
|
|
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** **(** :ref:`Object<class_Object>` script, :ref:`String<class_String>` method **)**
|
|
|
|
Emitted when the user requests to view a specific method of a script, similar to :ref:`request_open_script_at_line<class_ScriptEditorBase_signal_request_open_script_at_line>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ScriptEditorBase_signal_name_changed:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**name_changed** **(** **)**
|
|
|
|
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** **(** :ref:`String<class_String>` text **)**
|
|
|
|
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** **(** :ref:`String<class_String>` topic **)**
|
|
|
|
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** **(** :ref:`Object<class_Object>` script, :ref:`int<class_int>` line **)**
|
|
|
|
Emitted when the user requests to view a specific line of a script, similar to :ref:`go_to_method<class_ScriptEditorBase_signal_go_to_method>`.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ScriptEditorBase_signal_request_save_history:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**request_save_history** **(** **)**
|
|
|
|
Emitted when the user contextual goto and the item is in the same script.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ScriptEditorBase_signal_search_in_files_requested:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**search_in_files_requested** **(** :ref:`String<class_String>` text **)**
|
|
|
|
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** **(** :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` highlighter **)**
|
|
|
|
Adds a :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` to the open script.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ScriptEditorBase_method_get_base_editor:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`Control<class_Control>` **get_base_editor** **(** **)** |const|
|
|
|
|
Returns the underlying :ref:`Control<class_Control>` used for editing scripts. For text scripts, this is a :ref:`CodeEdit<class_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.)`
|