classref: Sync with latest 4.0-dev

classes/class_scripteditorbase.rst

@@ -0,0 +1,107 @@
+:github_url: hide
+
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the ScriptEditorBase.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _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>`.
+
+Description
+-----------
+
+Base editor for editing scripts in the :ref:`ScriptEditor<class_ScriptEditor>`, this does not include documentation items.
+
+Methods
+-------
+
++-------------------------------+-------------------------------------------------------------------------------------------+
+| :ref:`Control<class_Control>` | :ref:`get_base_editor<class_ScriptEditorBase_method_get_base_editor>` **(** **)** |const| |
++-------------------------------+-------------------------------------------------------------------------------------------+
+
+Signals
+-------
+
+.. _class_ScriptEditorBase_signal_edited_script_changed:
+
+- **edited_script_changed** **(** **)**
+
+Emitted after script validation. For visual scripts on modification.
+
+----
+
+.. _class_ScriptEditorBase_signal_go_to_help:
+
+- **go_to_help** **(** :ref:`String<class_String>` what **)**
+
+Emitted when the user requests a specific documentation page.
+
+----
+
+.. _class_ScriptEditorBase_signal_name_changed:
+
+- **name_changed** **(** **)**
+
+Emitted after script validation or when the edited resource has changed. Not used by visual scripts.
+
+----
+
+.. _class_ScriptEditorBase_signal_replace_in_files_requested:
+
+- **replace_in_files_requested** **(** :ref:`String<class_String>` text **)**
+
+Emitted when the user request to find and replace text in the file system. Not used by visual scripts.
+
+----
+
+.. _class_ScriptEditorBase_signal_request_help:
+
+- **request_help** **(** :ref:`String<class_String>` topic **)**
+
+Emitted when the user requests contextual help.
+
+----
+
+.. _class_ScriptEditorBase_signal_request_open_script_at_line:
+
+- **request_open_script_at_line** **(** :ref:`Object<class_Object>` script, :ref:`int<class_int>` line **)**
+
+Emitted when the user requests a script.
+
+----
+
+.. _class_ScriptEditorBase_signal_request_save_history:
+
+- **request_save_history** **(** **)**
+
+Emitted when the user contextual goto and the item is in the same script.
+
+----
+
+.. _class_ScriptEditorBase_signal_search_in_files_requested:
+
+- **search_in_files_requested** **(** :ref:`String<class_String>` text **)**
+
+Emitted when the user request to search text in the file system. Not used by visual scripts.
+
+Method Descriptions
+-------------------
+
+.. _class_ScriptEditorBase_method_get_base_editor:
+
+- :ref:`Control<class_Control>` **get_base_editor** **(** **)** |const|
+
+Returns the underlying :ref:`Control<class_Control>` used for editing scripts. This can be either :ref:`CodeEdit<class_CodeEdit>` (for text scripts) or :ref:`GraphEdit<class_GraphEdit>` (for visual scripts).
+
+.. |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.)`