:github_url: hide .. _class_ScriptEditor: ScriptEditor ============ **Наследует:** :ref:`PanelContainer` **<** :ref:`Container` **<** :ref:`Control` **<** :ref:`CanvasItem` **<** :ref:`Node` **<** :ref:`Object` Редактор скриптов редактора Godot. .. rst-class:: classref-introduction-group Описание ---------------- Редактор скриптов редактора Godot. \ **Примечание:** Этот класс не следует инстанцировать напрямую. Вместо этого получите доступ к синглтону с помощью :ref:`EditorInterface.get_script_editor()`. .. rst-class:: classref-reftable-group Методы ------------ .. table:: :widths: auto +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_docs_from_script`\ (\ script\: :ref:`Script`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_breakpoints`\ (\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ScriptEditorBase` | :ref:`get_current_editor`\ (\ ) |const| | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Script` | :ref:`get_current_script`\ (\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`ScriptEditorBase`\] | :ref:`get_open_script_editors`\ (\ ) |const| | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Script`\] | :ref:`get_open_scripts`\ (\ ) |const| | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`goto_help`\ (\ topic\: :ref:`String`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`goto_line`\ (\ line_number\: :ref:`int`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`open_script_create_dialog`\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`register_syntax_highlighter`\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`unregister_syntax_highlighter`\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_docs_from_script`\ (\ script\: :ref:`Script`\ ) | +------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Сигналы -------------- .. _class_ScriptEditor_signal_editor_script_changed: .. rst-class:: classref-signal **editor_script_changed**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Выдается, когда пользователь изменил активный скрипт. Аргумент — недавно активированный :ref:`Script`. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_signal_script_close: .. rst-class:: classref-signal **script_close**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Выдается, когда редактор собирается закрыть активный скрипт. Аргумент — :ref:`Script`, который будет закрыт. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Описания метода ------------------------------ .. _class_ScriptEditor_method_clear_docs_from_script: .. rst-class:: classref-method |void| **clear_docs_from_script**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Удаляет документацию для указанного ``script``. \ **Примечание:** Этот вызов следует выполнять при каждом изменении скрипта, чтобы поддерживать состояние открытой документации в актуальном состоянии. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_breakpoints: .. rst-class:: classref-method :ref:`PackedStringArray` **get_breakpoints**\ (\ ) :ref:`🔗` Возвращает массив точек останова. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_current_editor: .. rst-class:: classref-method :ref:`ScriptEditorBase` **get_current_editor**\ (\ ) |const| :ref:`🔗` Возвращает объект :ref:`ScriptEditorBase`, который пользователь в данный момент редактирует. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_current_script: .. rst-class:: classref-method :ref:`Script` **get_current_script**\ (\ ) :ref:`🔗` Возвращает :ref:`Script`, который в данный момент активен в редакторе. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_open_script_editors: .. rst-class:: classref-method :ref:`Array`\[:ref:`ScriptEditorBase`\] **get_open_script_editors**\ (\ ) |const| :ref:`🔗` Возвращает массив со всеми объектами :ref:`ScriptEditorBase`, которые в данный момент открыты в редакторе. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_get_open_scripts: .. rst-class:: classref-method :ref:`Array`\[:ref:`Script`\] **get_open_scripts**\ (\ ) |const| :ref:`🔗` Возвращает массив со всеми объектами :ref:`Script`, которые в данный момент открыты в редакторе. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_goto_help: .. rst-class:: classref-method |void| **goto_help**\ (\ topic\: :ref:`String`\ ) :ref:`🔗` Открывает справку по заданной теме. ``topic`` — это закодированная строка, которая управляет тем, какой класс, метод, константа, сигнал, аннотация, свойство или элемент темы должны быть в фокусе. Поддерживаемые форматы ``topic`` включают ``class_name:class``, ``class_method:class:method``, ``class_constant:class:constant``, ``class_signal:class:signal``, ``class_annotation:class:@annotation``, ``class_property:class:property`` и ``class_theme_item:class:item``, где ``class`` — имя класса, ``method`` — имя метода, ``constant`` — имя константы, ``signal`` — имя сигнала, ``annotation`` — имя аннотации, ``property`` — имя свойства, а ``item`` — элемент темы. :: # Показывает справку по классу Node. class_name:Node # Показывает справку по глобальной функции min. # Глобальные объекты доступны в пространстве имен `@GlobalScope`, показанном здесь. class_method:@GlobalScope:min # Показывает справку по get_viewport в классе Node. class_method:Node:get_viewport # Показывает справку по константе ввода MOUSE_BUTTON_MIDDLE. class_constant:Input:MOUSE_BUTTON_MIDDLE # Показывает справку по нажатому сигналу BaseButton. class_signal:BaseButton:pressed # Показывает справку по свойству CanvasItem visible. class_property:CanvasItem:visible # Показывает справку по экспорту аннотаций GDScript. # Аннотации должны начинаться с символа `@` в дескрипторе, как показано здесь. class_annotation:@GDScript:@export # Показывает справку по элементу темы GraphNode с именем panel_selected. class_theme_item:GraphNode:panel_selected .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_goto_line: .. rst-class:: classref-method |void| **goto_line**\ (\ line_number\: :ref:`int`\ ) :ref:`🔗` Переход к указанной строке текущего скрипта. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_open_script_create_dialog: .. rst-class:: classref-method |void| **open_script_create_dialog**\ (\ base_name\: :ref:`String`, base_path\: :ref:`String`\ ) :ref:`🔗` Открывает диалог создания скрипта. Скрипт будет расширять ``base_name``. Расширение файла может быть опущено в ``base_path``. Оно будет добавлено на основе выбранного языка скрипта. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_register_syntax_highlighter: .. rst-class:: classref-method |void| **register_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Регистрирует :ref:`EditorSyntaxHighlighter` в редакторе, :ref:`EditorSyntaxHighlighter` будет доступен во всех открытых скриптах. \ **Примечание:** Не применяется к уже открытым скриптам. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_unregister_syntax_highlighter: .. rst-class:: classref-method |void| **unregister_syntax_highlighter**\ (\ syntax_highlighter\: :ref:`EditorSyntaxHighlighter`\ ) :ref:`🔗` Отменяет регистрацию :ref:`EditorSyntaxHighlighter` в редакторе. \ **Примечание:** :ref:`EditorSyntaxHighlighter` по-прежнему будет применяться к скриптам, которые уже открыты. .. rst-class:: classref-item-separator ---- .. _class_ScriptEditor_method_update_docs_from_script: .. rst-class:: classref-method |void| **update_docs_from_script**\ (\ script\: :ref:`Script`\ ) :ref:`🔗` Обновляет документацию для указанного ``script``. \ **Примечание:** Этот вызов следует выполнять при каждом изменении скрипта, чтобы поддерживать открытую документацию в актуальном состоянии. .. |virtual| replace:: :abbr:`virtual (Этот метод обычно должен быть переопределен пользователем, чтобы иметь какой-либо эффект.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Этот метод не имеет побочных эффектов. Он не изменяет ни одну из переменных-членов экземпляра.)` .. |vararg| replace:: :abbr:`vararg (Этот метод принимает любое количество аргументов после описанных здесь.)` .. |constructor| replace:: :abbr:`constructor (Этот метод используется для создания типа.)` .. |static| replace:: :abbr:`static (Этот метод не нуждается в вызове экземпляра, поэтому его можно вызвать напрямую, используя имя класса.)` .. |operator| replace:: :abbr:`operator (Этот метод описывает допустимый оператор для использования с этим типом в качестве левого операнда.)` .. |bitfield| replace:: :abbr:`BitField (Это значение является целым числом, составленным как битовая маска следующих флагов.)` .. |void| replace:: :abbr:`void (Нет возвращаемого значения.)`