classref: Sync with current master branch (705b7a0)

This commit is contained in:
Godot Organization
2024-05-31 13:54:35 +00:00
parent 32f1b6ea48
commit eacfba2716
835 changed files with 17350 additions and 17256 deletions

View File

@@ -64,7 +64,7 @@ Signals
.. rst-class:: classref-signal
**editor_script_changed**\ (\ script\: :ref:`Script<class_Script>`\ )
**editor_script_changed**\ (\ script\: :ref:`Script<class_Script>`\ ) :ref:`🔗<class_ScriptEditor_signal_editor_script_changed>`
Emitted when user changed active script. Argument is a freshly activated :ref:`Script<class_Script>`.
@@ -76,7 +76,7 @@ Emitted when user changed active script. Argument is a freshly activated :ref:`S
.. rst-class:: classref-signal
**script_close**\ (\ script\: :ref:`Script<class_Script>`\ )
**script_close**\ (\ script\: :ref:`Script<class_Script>`\ ) :ref:`🔗<class_ScriptEditor_signal_script_close>`
Emitted when editor is about to close the active script. Argument is a :ref:`Script<class_Script>` that is going to be closed.
@@ -93,7 +93,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`ScriptEditorBase<class_ScriptEditorBase>` **get_current_editor**\ (\ ) |const|
:ref:`ScriptEditorBase<class_ScriptEditorBase>` **get_current_editor**\ (\ ) |const| :ref:`🔗<class_ScriptEditor_method_get_current_editor>`
Returns the :ref:`ScriptEditorBase<class_ScriptEditorBase>` object that the user is currently editing.
@@ -105,7 +105,7 @@ Returns the :ref:`ScriptEditorBase<class_ScriptEditorBase>` object that the user
.. rst-class:: classref-method
:ref:`Script<class_Script>` **get_current_script**\ (\ )
:ref:`Script<class_Script>` **get_current_script**\ (\ ) :ref:`🔗<class_ScriptEditor_method_get_current_script>`
Returns a :ref:`Script<class_Script>` that is currently active in editor.
@@ -117,7 +117,7 @@ Returns a :ref:`Script<class_Script>` that is currently active in editor.
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`ScriptEditorBase<class_ScriptEditorBase>`\] **get_open_script_editors**\ (\ ) |const|
:ref:`Array<class_Array>`\[:ref:`ScriptEditorBase<class_ScriptEditorBase>`\] **get_open_script_editors**\ (\ ) |const| :ref:`🔗<class_ScriptEditor_method_get_open_script_editors>`
Returns an array with all :ref:`ScriptEditorBase<class_ScriptEditorBase>` objects which are currently open in editor.
@@ -129,7 +129,7 @@ Returns an array with all :ref:`ScriptEditorBase<class_ScriptEditorBase>` object
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Script<class_Script>`\] **get_open_scripts**\ (\ ) |const|
:ref:`Array<class_Array>`\[:ref:`Script<class_Script>`\] **get_open_scripts**\ (\ ) |const| :ref:`🔗<class_ScriptEditor_method_get_open_scripts>`
Returns an array with all :ref:`Script<class_Script>` objects which are currently open in editor.
@@ -141,7 +141,7 @@ Returns an array with all :ref:`Script<class_Script>` objects which are currentl
.. rst-class:: classref-method
|void| **goto_help**\ (\ topic\: :ref:`String<class_String>`\ )
|void| **goto_help**\ (\ topic\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ScriptEditor_method_goto_help>`
Opens help for the given topic. The ``topic`` is an encoded string that controls which class, method, constant, signal, annotation, property, or theme item should be focused.
@@ -178,7 +178,7 @@ The supported ``topic`` formats include ``class_name:class``, ``class_method:cla
.. rst-class:: classref-method
|void| **goto_line**\ (\ line_number\: :ref:`int<class_int>`\ )
|void| **goto_line**\ (\ line_number\: :ref:`int<class_int>`\ ) :ref:`🔗<class_ScriptEditor_method_goto_line>`
Goes to the specified line in the current script.
@@ -190,7 +190,7 @@ Goes to the specified line in the current script.
.. rst-class:: classref-method
|void| **open_script_create_dialog**\ (\ base_name\: :ref:`String<class_String>`, base_path\: :ref:`String<class_String>`\ )
|void| **open_script_create_dialog**\ (\ base_name\: :ref:`String<class_String>`, base_path\: :ref:`String<class_String>`\ ) :ref:`🔗<class_ScriptEditor_method_open_script_create_dialog>`
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.
@@ -202,7 +202,7 @@ Opens the script create dialog. The script will extend ``base_name``. The file e
.. rst-class:: classref-method
|void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>`\ )
|void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>`\ ) :ref:`🔗<class_ScriptEditor_method_register_syntax_highlighter>`
Registers the :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` to the editor, the :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` will be available on all open scripts.
@@ -216,7 +216,7 @@ Registers the :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` to t
.. rst-class:: classref-method
|void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>`\ )
|void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>`\ ) :ref:`🔗<class_ScriptEditor_method_unregister_syntax_highlighter>`
Unregisters the :ref:`EditorSyntaxHighlighter<class_EditorSyntaxHighlighter>` from the editor.