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...

Редактор сценаріїв

Вступ

Редактор сценаріїв Godot Engine — це потужний і повністю інтегрований текстовий редактор, який не тільки оптимізує процес написання та налагодження коду, написаного в GDScript, але також дозволяє працювати зі звичайними текстовими файлами, забезпечуючи розробникам безперебійне середовище для створення сценаріїв ігрової логіки та поведінки. Він може виділяти ваш код, автоматично робити відступи, виконувати перевірку синтаксису та багато іншого. Ви також можете створити контрольні точки для налагодження проекту без переходу в інше вікно. Текстовий редактор також слугує офлайн-переглядачем довідкових даних про класи, доступ до якого можна отримати кількома способами, як описано в Інтегрована довідка про класи.

Особливості

Нижче наведено деякі ключові функції текстового редактора:

• Повністю інтегрований редактор коду для GDScript.

• Підтримка підсвічування синтаксису для файлів GDScript і JSON.

• Перевірка синтаксису файлів GDScript і JSON.

• Підтримка закладок і точок зупину.

• Автоматичний відступ.

• Складання коду.

• Настроювана тема.

• Кілька вставок, які можна активувати за допомогою Alt + Left Click.

• Автозаповнення змінних, функцій, констант тощо.

• Вбудований рефакторинг символів шляхом їх вибору та використання Ctrl + D.

• Масовий пошук і заміна файлів проекту.

Використання

Якщо ви використовуєте GDScript у своєму проекті, вбудований текстовий редактор у Godot надасть усе, що вам потрібно, служачи єдиним місцем для повного використання Godot Engine. Майже всі параметри, які можна налаштувати через інтерфейс користувача, також можна змінити безпосередньо за допомогою коду.

Примітка

Якщо ви хочете використовувати зовнішній текстовий редактор або надаєте перевагу використанню C# у своєму проекті, перегляньте Використання зовнішнього текстового редактора і Налаштування зовнішнього редактора.

Порада

Подібно до багатьох частин інтерфейсу Godot, текстовий редактор також можна налаштувати, змінивши його налаштування на свій смак. Ви можете отримати доступ до цих налаштувань, відкривши Редактор > Параметри редактора і перейшовши до групи Текстовий редактор.

Ви можете відкрити Редактор скрипти за допомогою кнопки Скрипт у селекторі робочої області, розташованому вгорі по центру інтерфейсу Godot. Крім того, ви можете скористатися кнопкою Відкрити скрипт поруч із вузлом у панелі дерева сцен або двічі клацнути файл .gd або розпізнаний текстовий файл у панелі файлової системи, щоб відкрити його безпосередньо в редакторі скрипта.

Відкривши його, ви побачите меню текстового редактора вгорі, під перемикачем сцен. Поруч із меню ви знайдете кнопки для відкриття онлайн-документації або пошуку у вбудованому довідковому класі. Праворуч від цих кнопок є дві навігаційні стрілки, за допомогою яких можна переміщатися по історії переглядів. Нарешті, ви можете використовувати плаваючу кнопку, щоб відокремити текстовий редактор від вікна Godot, що корисно, якщо ви працюєте з кількома моніторами.

Під меню ліворуч ви побачите панель сценаріїв. У центрі, поруч із панеллю сценаріїв, знаходиться область кодування. Під областю кодування знаходиться рядок стану, який відображає кількість помилок і попереджень у коді. Якщо натиснути піктограму помилки чи попередження, буде показано список помилок із номерами рядків. Натиснувши на один, ви перейдете до цього рядка. Ви також можете ігнорувати попередження, відкривши список і натиснувши Ігнорувати. Рядок стану також дозволяє змінювати рівень масштабування коду, натискаючи значення у відсотках. Ви також можете використовувати Ctrl + Mouse Wheel (Cmd + Mouse Wheel на Mac), щоб досягти того самого ефекту. Рядок стану також показує поточну позицію каретки щодо рядка та стовпця, а також те, чи зроблено відступ за допомогою табуляції чи пробілів.

Багато дій, які виконуються в текстовому редакторі, також можна виконувати за допомогою ярликів. Поруч із діями відображаються відповідні ярлики. Щоб отримати повний список комбінацій клавіш, перегляньте text editor shortcuts.

У наступних розділах ми розглянемо різні аспекти текстового редактора. Ви також можете вибрати розділ нижче, щоб перейти до певної теми:

Панель сценаріїв

Під меню, на лівій панелі, ви побачите список відкритих файлів і сторінок документації. Залежно від типу файлу цей список матиме піктограму поруч із назвою файлу. Наприклад, значок означає, що це GDScript. означає, що це скрипт C#. означає, що це вбудоване посилання на клас. Нарешті означає, що це поточний скрипт (див. tool annotation, щоб дізнатися більше про це). Якщо навести курсор на файл, з’явиться спливаюча підказка з його відносним розташуванням у папці проекту.

У рядку стану клацання стрілки ліворуч приховує панель сценаріїв, клацання стрілки праворуч показує її.

Якщо ви не змінювали жодних налаштувань, імена файлів також можуть мати інший колір. Це допоможе вам визначити нещодавно відредаговані файли, виділивши їх. Цю поведінку можна змінити в Редактор > Параметри редактора, налаштувавши властивості Температура сценарію в розділі Текстовий редактор.

Панель фільтрів над іменами файлів запроваджує зручний пошук без урахування регістру для пошуку певного файлу. Навіть якщо ви просто введете літери імені файлу на панелі, файли, які містять ці літери по порядку, також з’являться. Припустімо, що в списку є файл із назвою button.gd. Якщо ви введете btn на панелі фільтрів, цей файл з’явиться в результатах. Щоб скинути фільтр, очистіть панель фільтрів.

Зірочка (*) біля назви файлу означає, що файл має незбережені зміни.

Порада

Якщо ви просто введете «*» на панелі фільтрів, ви зможете відобразити всі незбережені файли.

Ви можете перетягнути файл, щоб змінити порядок. Клацання середньою кнопкою миші на файлі закриває його. Клацання правою кнопкою миші на файлі надає кілька варіантів збереження або закриття файлів або копіювання відносного шляху до файлу. У цьому меню:

Ви також можете використовувати Перемістити вгору і Перемістити вниз, щоб змінити порядок файлів, або використати Сортувати, щоб відсортувати всі файли за алфавітом. Переключити панель сценаріїв приховує панель, яку можна знову відобразити за допомогою стрілки вправо на панелі стану. Закрити документи закриває всі відкриті довідкові документи в класі, залишаючи відкритими лише файли сценаріїв. Показати у FileSystem знаходить і виділяє файл у док-станції FileSystem.

Під списком файлів ви побачите назву поточного відкритого файлу. Кнопка поруч із цим перемикає порядок методів, визначених у цьому файлі, між алфавітним і таким, як вони з’являються. Під цим контур файлу. Якщо це файл сценарію, він міститиме список визначених методів. Проте, якщо відкрита довідкова сторінка класу, у цій області буде показано зміст цього документа. Клацнувши елемент у цьому списку, ви перейдете до відповідної функції або розділу у файлі. Подібним чином панель Методи фільтрації дозволяє шукати певну функцію або розділ у вибраному документі з такою ж поведінкою, що й сценарії фільтрації.

Меню

Меню текстового редактора знаходяться під перемикачем сцен і дозволяють отримати доступ до різноманітних інструментів і параметрів, таких як керування файлами, пошук і заміна, елементи керування налагодженням і функції форматування коду.

Порада

Зірочка (*) біля дії означає, що ця операція також доступна в контекстному меню, яке можна відкрити, клацнувши правою кнопкою миші в редакторі коду.

Меню Файл містить такі параметри:

• Новий скрипт...: відкриває діалогове вікно нового скрипт для створення та додавання скрипт до проекту. Якщо створення буде успішним, його буде відкрито безпосередньо в текстовому редакторі. Залежно від версії Godot (з підтримкою C# чи ні), ви можете вибрати .gd або .cs як розширення.

• Новий текстовий файл...: відкриває діалогове вікно файлу для створення простого текстового файлу в одному з розпізнаних форматів. Godot також може виділяти файли json.

• Відкрити...: відкриває діалогове вікно файлу, у якому можна переглядати вміст комп’ютера та вибирати будь-який розпізнаний текстовий файл для його відкриття.

• Повторно відкрити закритий скрипт: повторно відкриває останні закриті сценарії. Ви можете використовувати цей параметр кілька разів, щоб повторно відкрити інші закриті сценарії, якщо ви закрили більше одного.

• Open Recent: надає список останніх відкритих сценаріїв. Ви також можете очистити список за допомогою наданої опції внизу списку.

• Зберегти: зберігає поточний вибраний скрипт.

• Зберегти як...: відкриває діалогове вікно файлу для збереження поточного відкритого сценарію під іншою назвою.

• Зберегти все: зберігає всі незбережені відкриті сценарії в текстовому редакторі. Сценарії з незбереженими змінами матимуть зірочку (*) поруч зі своїми іменами у списку сценаріїв.

• Скрипт програмного перезавантаження інструменту: якщо вибраний скрипт є tool, перезавантажує скрипт, щоб виконати його знову.

• Копіювати шлях сценарію: копіює відносний шлях поточного вибраного сценарію в проекті за допомогою префікса res://.

• Показати у FileSystem: знаходить і виділяє вибраний файл у док-станції FileSystem.

• Історія Попередня: змінює активний скрипт на той, який був відкритий раніше. Це корисно, коли у вас відкрито декілька скрипти і ви хочете швидко повернутися до останнього сценарію, який ви редагували. Якщо ви також змінили позицію вставки більш ніж на 10 рядків, ви спочатку перемістите її на попереднє місце в тому самому файлі.

• Наступна історія: після використання Попередньої історії, щоб повернутися до попереднього сценарію, ця функція дає змогу рухатися вперед по історії сценаріїв, перемикаючись на сценарії, до яких ви зверталися раніше. Подібно до вищезазначеного, якщо ви також змінили позицію каретки більше ніж на 10 рядків, ви спочатку перемістите її до наступного розташування в тому самому файлі.

• Тема: надає параметри для імпорту існуючої теми, збереження або перезавантаження. Зміна налаштувань теми виконується через Налаштування редактора.

• Закрити: закриває активний скрипт.

• Закрити все: закриває всі відкриті сценарії та пропонує зберегти незбережені зміни.

• Закрити інші вкладки: закриває всі відкриті сценарії, крім вибраного.

• Закрити документи: закриває сторінки довідкової документації класу, залишаючи лише сценарії.

• Виконати: якщо скрипт розширює EditorScript і призначений для виконання без запуску проекту, цей параметр запускає скрипт. Перегляньте Запуск одноразових сценаріїв за допомогою EditorScript для отримання додаткової інформації.

• Переключити панель сценаріїв: показує або приховує панель сценаріїв, розташовану ліворуч від текстового редактора, що дозволяє розширити доступну область кодування. Докладніше про Панель сценаріїв пояснено above.

Меню Редагувати надає кілька варіантів для операцій із лініями:

• Скасувати*: дозволяє скасувати останню дію або серію дій, відновлюючи документ або код до попереднього стану до внесення змін.

• Повторити*: дозволяє повторно застосувати дію, яку раніше було скасовано, фактично повторюючи останню дію, яку було скасовано функцією «Скасувати».

• Вирізати*: вирізає виділення в буфер обміну.

• Копіювати*: копіює виділення в буфер обміну.

• Вставити*: вставляє вміст буфера обміну, якщо він містить текст.

• Вибрати все*: вибирає весь код у текстовому редакторі.

• Дублювати виділене: копіює виділений фрагмент і додає його поруч із виділеним.

• Дублювати рядки: дублює поточний рядок і додає його як новий рядок під поточним рядком.

• Оцінити виділення*: обчислює значення виділеного тексту, якщо він містить лише математичний вираз, як-от 83 * 3 або pow(2,3).

• Увімкнути перенесення слів: вимикає горизонтальну смугу прокручування шляхом переносу довгих рядків на наступний рядок. Зауважте, що це лише візуальна зміна, і нові розриви рядків не додаються.

• Рядок: надає набір операцій із рядком. Залежно від відкритого файлу параметри також можуть бути безпосередньо в меню «Редагувати», а не у підменю.

  • Вгору: переміщує поточний рядок або вибрані рядки на один рядок вище.

  • Перемістити вниз: переміщує поточний рядок або вибрані рядки на один рядок вниз.

  • Відступ*: робить відступ тексту від каретки або виділених рядків відповідно до параметрів відступу.

  • Скасувати відступи*: знімає відступи тексту від каретки або виділених рядків відповідно до параметрів відступу.

  • Видалити рядок: видаляє поточний рядок або вибрані рядки.

  • Переключити коментар*: коментує та розкоментовує поточний рядок або вибрані рядки. Ви можете виконати таку саму дію, вибравши рядки та вибравши ту саму дію після клацання правою кнопкою миші на виділеному тексті.

• Складання: надає набір параметрів згортання для виділеного тексту. Залежно від відкритого файлу параметри також можуть бути безпосередньо в меню «Редагувати», а не у підменю.

  • Рядок згортання/розгортання*: якщо код у поточному рядку містить блок коду або область коду під ним, він приховує цей блок, згортаючи рядки. Потім ви можете знову розгорнути його за допомогою цієї опції, використовуючи стрілку «>» поруч із номером рядка в області кодування або клацнувши піктограму з крапкою «...» у кінці складеного рядка.

  • Згорнути всі рядки: згортає всі блоки коду або області коду у відкритому документі.

  • Розгорнути всі рядки: розгортає всі блоки коду та області коду у відкритому документі.

  • Створити область коду*: обгортає виділений текст у область коду, що згортається, щоб покращити читабельність великих сценаріїв. Перегляньте Вбудовані типи для отримання додаткової інформації.

• Запит на завершення: пропонує використовувати вбудовані або створені користувачем символи для автоматичного завершення частково написаного коду. Up і Down переміщаються вгору та вниз, натискання Enter або Tab приймає та додає виділений символ до коду. Tab також замінить існуючий текст праворуч від каретки.

• Обрізати кінцеві пробіли: видаляє зайві пробіли в кінці кожного рядка у файлі.

• Обрізати останні нові рядки: видаляє додаткові нові рядки в кінці файлу.

• Відступ: надає параметри для відступу відкритого файлу. Залежно від відкритого файлу параметри також можуть бути безпосередньо в меню «Редагувати», а не у підменю.

  • Перетворити відступи на пробіли: перетворює всі відступи у файлі на пробіли.

  • Перетворити відступи на вкладки: перетворює всі відступи у файлі на вкладки.

  • Автоматичний відступ: перетворює відступ вибраних рядків (або всього файлу) відповідно до параметрів відступу.

• Перетворити регістр: змінює регістр вибраного тексту на Великий регістр*, Нижній регістр* або робить кожну початкову літеру слів великою.

• Підсвічувач синтаксису: дозволяє вибрати підсвічування синтаксису.

  • Звичайний текст: вимикає виділення.

  • Стандартний: виділення за замовчуванням для сценаріїв C#.

  • JSON: підсвічування синтаксису для файлів JSON.

  • GDScript: підсвічування синтаксису для файлів GDScript.

Меню Пошук містить такі параметри:

• Знайти...: відкриває панель швидкого пошуку під рядком стану для пошуку тексту у відкритому файлі. Ви можете переходити до наступного збігу та попереднього збігу за допомогою стрілок вгору та вниз відповідно. Позначка Match Case робить пошук чутливим до регістру. Позначка Цілі слова означає, що поруч із текстом не повинно бути літер чи цифр, а лише символи та пробіли.

• Знайти далі: Подібно до стрілки вниз, показує наступне входження.

• Знайти попередній: подібно до стрілки вгору, показує попередній випадок.

• Замінити...: відкриває рядок пошуку та заміни під рядком стану, щоб знайти текст і замінити його у відкритому файлі. Ви можете замінити їх по одному або всі одночасно. Крім того, ви можете обмежити заміну виділеним текстом, установивши прапорець Лише виділення на панелі пошуку та заміни. Ви також можете використовувати Ctrl + D, щоб додатково вибрати наступний екземпляр поточного виділеного тексту, дозволяючи виконувати вбудовану заміну кількох входжень.

• Знайти у файлах...: відкриває вікно для пошуку тексту у файлах у папці проекту. Вибір «Знайти...» починається з вибраної папки та включає розширення файлів, позначені у фільтрах. Результати відображаються на нижній панелі з кількістю збігів і загальною кількістю знайдених файлів на вкладці Результати пошуку. Натискання на результат відкриває файл і переходить до відповідного рядка.

• Замінити у файлах...: відкриває вікно для пошуку та заміни тексту іншим текстом у знайдених файлах у папці проекту. Після натискання Замінити... ви можете вибрати, у яких файлах замінити, за допомогою вкладки Результати пошуку на нижній панелі, (знявши) прапорці та натиснувши кнопку Замінити все.

Попередження

Зауважте, що операцію «Замінити у файлах» неможливо скасувати!

Порада

Обидва вікна Знайти у файлах і Замінити у файлах мають спільні кнопки Пошук... і Замінити.... Єдиною відмінністю останнього вікна є додаткове текстове поле, яке автоматично заповнює панель результатів пошуку після натискання кнопки Замінити.... Операція заміни виконується, лише якщо ви натиснете кнопку Замінити все на цій нижній панелі, дозволяючи вам також редагувати слово для заміни пізніше на цій панелі.

• Контекстна довідка*: відкриває список вбудованих посилань на класи, подібно до натискання F1 на символі або вибору Пошук символу з контекстного меню.

Меню Перейти дозволяє легко переміщатися в коді за допомогою таких параметрів:

• Перейти до функції...: відкриває список функцій для переходу. Ви можете досягти того самого результату, ввівши на панелі методів фільтрування на панелі сценаріїв.

• Перейти до рядка...: Перехід до введеного номера рядка в редакторі коду.

• Закладки: містить дії для функції закладок, які можна використовувати, щоб легше знаходити свій код, наприклад неповний розділ. Рядки з закладками матимуть синій символ закладки ліворуч від номера рядка.

  • Переключити закладку*: додає або видаляє закладку в рядку, де знаходиться курсор. Ви також можете клацнути правою кнопкою миші на рядку, щоб досягти цього.

  • Видалити всі закладки: видаляє всі закладки у відкритому документі.

  • Перейти до наступної закладки: Перехід до наступної закладки у відкритому документі.

  • Перейти до попередньої закладки: Перехід до попередньої закладки у відкритому документі.

  • Меню Закладки також міститиме список рядків із закладками, включно з їхніми номерами та відображенням часткового вмісту цього рядка.

• Точки зупину: точки зупину корисні під час налагодження коду. Подібно до меню Закладки, це меню дозволяє додавати або видаляти точки зупинки, переміщатися між ними та безпосередньо переходити до певної точки зупинки. Простий спосіб додати точку зупину – навести курсор на порожню область зліва від номера рядка. На ньому буде вицвіле червоне коло. Натиснувши її, ви додасте точку розриву, і коло залишиться там. Натискання на коло видаляє точку розриву.

Меню Debug пропонує дії, які можна використовувати під час налагодження. Перегляньте Інструменти та параметри налагодження редактора сценаріїв для отримання додаткової інформації.

Зона кодування

Примітка

У цьому розділі розглядатимуться лише основи області кодування з точки зору інтерфейсу користувача. Щоб дізнатися більше про сценарії в Godot, зверніться до документації Скрипт або Scripting.

Область кодування – це місце, де ви будете вводити свої сценарії, якщо ви використовуєте вбудований текстовий редактор. Він пропонує функції виділення та автозавершення, які допоможуть вам під час кодування.

Область кодування показує номери рядків зліва. Під навігаційними стрілками з правого боку є міні-карта, яку можна натиснути, яка надає огляд усього сценарію та дозволяє прокручувати його.

Якщо рядок коду достатньо довгий (більше 80 символів за замовчуванням), текстовий редактор відобразить вертикальну лінію, яку можна використовувати як м’яку вказівку. Для жорстких рекомендацій це значення встановлено на 100 символів за замовчуванням. Обидва значення можна змінити або перемкнути відображення лінії в налаштуваннях «Вигляд» текстового редактора.

У скрипті, ліворуч від визначень функцій, ви можете побачити додаткові значки. Значок вказує, що ця функція є override існуючої функції. Натискання на нього відкриває документацію оригінальної функції. Значок означає, що це метод отримання сигналу. Натискання на нього показує, звідки надходить сигнал. Значок ліворуч від рядка позначає блок, який можна згорнути. Ви можете натиснути, щоб згорнути або розгорнути його. Крім того, можна натиснути значок трикрапки (...), щоб розгорнути згорнутий блок.

Наведений нижче приклад підсумовує наведений вище абзац. Рядки 52, 56 і 58 — це блоки, які можна згорнути, рядок 57 — це область коду з назвою «New Code Region», яку також можна згорнути, а лінія 62 — це згорнутий блок. Рядок 53 — це закладка, до якої можна швидко перейти за допомогою меню Перейти до > Закладки. Рядок 55 — це точка зупину, яку можна використовувати в debugging.

Можна налаштувати багато кольорів текстового редактора, наприклад кольори підсвічування або навіть кольори значків точки зупинки чи закладки. Ви можете експериментувати з ними, відкривши налаштування текстового редактора, перейшовши до розділу Редактор > Параметри редактора > Текстовий редактор.