Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ScriptEditor

Успадковує: PanelContainer < Container < Control < CanvasItem < Node < Object

Автор сценарію Godot.

Опис

Автор сценарію Godot.

Примітка: Цей клас не повинен бути миттєвим. Замість, доступ до Єдиного редактора EditorInterface.get_script_editor().

Методи

void	clear_docs_from_script(script: Script)
Error	close_file(path: String)
PackedStringArray	get_breakpoints()
ScriptEditorBase	get_current_editor() const
Script	get_current_script()
Array[ScriptEditorBase]	get_open_script_editors() const
Array[Script]	get_open_scripts() const
PackedStringArray	get_unsaved_files() const
void	goto_help(topic: String)
void	goto_line(line_number: int)
void	open_script_create_dialog(base_name: String, base_path: String)
void	register_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter)
void	reload_open_files()
void	save_all_scripts()
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.

Примітка: Цю функцію слід викликати щоразу, коли скрипт змінюється, щоб підтримувати стан відкритої документації в актуальному стані.

Error close_file(path: String) 🔗

Закриває файл за вказаним path, відкидаючи всі незбережені зміни.

Повертає @GlobalScope.OK у разі успіху або @GlobalScope.ERR_FILE_NOT_FOUND, якщо файл не знайдено.

PackedStringArray get_breakpoints() 🔗

Повертає масив точок зупину.

ScriptEditorBase get_current_editor() const 🔗

Повернення об'єкта scriptEditorBase, що користувач наразі редагування.

Script get_current_script() 🔗

Повернутися до Script, який наразі працює у редакторі.

Array[ScriptEditorBase] get_open_script_editors() const 🔗

Повертає масив з усіма об'єктами ScriptEditorBase, які в даний час відкриті в редакторі.

Array[Script] get_open_scripts() const 🔗

Повертає масив з усіма об'єктами Script, які в даний час відкриті в редакторі.

PackedStringArray get_unsaved_files() const 🔗

Повертає масив шляхів до файлів скриптів, які містять незбережені зміни та відкриті в редакторі.

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 reload_open_files() 🔗

Перезавантажує всі поточні відкриті файли. Цю функцію слід використовувати, коли зміна відкритих файлів відбувається поза межами редактора скриптів. Користувачеві може бути запропоновано вирішити конфлікти файлів; див. EditorSettings.text_editor/behavior/files/auto_reload_scripts_on_external_change.

void save_all_scripts() 🔗

Збереже всі відкриті скрипти.

void unregister_syntax_highlighter(syntax_highlighter: EditorSyntaxHighlighter) 🔗

Видаляє EditorSyntaxHighlighter з реєстру редактора.

Примітка: EditorSyntaxHighlighter залишиться в застосуванні вже відкритих скриптів.

void update_docs_from_script(script: Script) 🔗

Оновлює документацію для заданого script.

Примітка: Цю функцію слід викликати щоразу, коли скрипт змінюється, щоб підтримувати стан відкритої документації в актуальному стані.