ScriptEditor
Успадковує: PanelContainer < Container < Control < CanvasItem < Node < Object
Автор сценарію Godot.
Опис
Автор сценарію Godot.
Примітка: Цей клас не повинен бути миттєвим. Замість, доступ до Єдиного редактора EditorInterface.get_script_editor().
Методи
void |
clear_docs_from_script(script: Script) |
get_current_editor() const |
|
get_open_script_editors() const |
|
get_open_scripts() const |
|
void |
|
void |
|
void |
open_script_create_dialog(base_name: String, base_path: String) |
void |
register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) |
void |
unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) |
void |
update_docs_from_script(script: Script) |
Сигнали
editor_script_changed(script: Script) 🔗
Виникає, коли користувач змінює активний скрипт. Аргумент – це щойно активований скрипт. Script.
script_close(script: Script) 🔗
Викликається, коли редактор збирається закрити активний скрипт. Аргумент — це Script, який буде закрито.
Описи методів
void clear_docs_from_script(script: Script) 🔗
Видаляє документацію для заданого script.
Примітка: Цю функцію слід викликати щоразу, коли скрипт змінюється, щоб підтримувати стан відкритої документації в актуальному стані.
PackedStringArray get_breakpoints() 🔗
Повертає масив точок зупину.
ScriptEditorBase get_current_editor() const 🔗
Повернення об'єкта scriptEditorBase, що користувач наразі редагування.
Повернутися до Script, який наразі працює у редакторі.
Array[ScriptEditorBase] get_open_script_editors() const 🔗
Повертає масив з усіма об'єктами ScriptEditorBase, які в даний час відкриті в редакторі.
Array[Script] get_open_scripts() const 🔗
Повертає масив з усіма об'єктами Script, які в даний час відкриті в редакторі.
void goto_help(topic: String) 🔗
Відкриває довідку для заданої теми. 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 — анотація name, property – це ім’я властивості, а item – це елемент теми.
кодовий блок
# Показує довідку для класу Node.
class_name:вузол
# Показує довідку для глобальної функції min.
# Глобальні об’єкти доступні в просторі імен @GlobalScope, показаному тут.
class_method:@GlobalScope:мін
# Показує довідку для get_viewport у класі Node.
class_method:Node:get_viewport
# Показує довідку для константи введення MOUSE_BUTTON_MIDDLE.
class_constant:Input:MOUSE_BUTTON_MIDDLE
# Показує довідку для натиснутого сигналу BaseButton.
class_signal:BaseButton:натиснуто
# Показує видиму довідку для властивості CanvasItem.
class_property:CanvasItem:видимий
# Показує довідку для експорту анотації GDScript.
# Анотації мають мати префікс символу @ в дескрипторі, як показано тут.
class_annotation:@GDScript:@export
# Показує довідку для елемента теми GraphNode під назвою panel_selected.
class_theme_item:GraphNode:panel_selected
.. rst-class:: classref-item-separator
void goto_line(line_number: int) 🔗
Перейти до вказаної лінії в поточному скрипті.
void open_script_create_dialog(base_name: String, base_path: String) 🔗
Відкриває діалогове вікно створення скрипта. Скрипт розширюватиме base_name. Розширення файлу можна пропустити з base_path. Його буде додано на основі вибраної мови скриптів.
void register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) 🔗
Реєструє EditorSyntaxHighlighter у редакторі, EditorSyntaxHighlighter буде доступний для всіх відкритих скриптів.
Примітка: Не застосовується до скриптів, які вже відкриті.
void unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) 🔗
Видаляє EditorSyntaxHighlighter з реєстру редактора.
Примітка: EditorSyntaxHighlighter залишиться в застосуванні вже відкритих скриптів.
void update_docs_from_script(script: Script) 🔗
Оновлює документацію для заданого script.
Примітка: Цю функцію слід викликати щоразу, коли скрипт змінюється, щоб підтримувати стан відкритої документації в актуальному стані.