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 API
На цій сторінці ви дізнаєтеся, як читати посилання на клас для Godot API.
API, або інтерфейс прикладного програмування, є покажчиком того, що Godot пропонує користувачам. У ньому подано коротку інформацію про те, які класи існують, як вони пов’язані один з одним, які функції вони мають і як ними користуватися.
Успадкування
У верхній частині кожного файлу ви побачите назву класу.
У розділі «Наслідування» перераховано кожен клас, який успадковує поточний. Тут CanvasItem успадковує Node, а Node успадковує Object.
У розділі «Успадковано» перераховано кожен клас, який безпосередньо успадковує поточний клас. Тут Control і Node2D успадковують CanvasItem.
Короткий опис
Далі короткий опис класу. Цей текст з’являється у спливаючих вікнах редактора Godot для створення вузлів, ресурсів та інших типів.
Опис
Далі більш детальний опис класу, його функцій і варіантів використання.
Речі, які ви можете знайти тут:
Специфіка роботи класу.
Зразки коду типових випадків використання.
Деталі використання, які є спільними для кожного з методів класу.
Попередження про необхідні залежності або конфігурацію.
Посилання на інші пов’язані частини Godot API.
Посібники
Потім на сторінці надаються посилання на частини посібника, в яких згадується або використовується поточний клас.
Властивості
Таблиця властивостей містить перелік змінних, які належать до кожного екземпляра класу, також відомого як «властивості»
Ліва колонка містить тип даних властивості. Текст також є посиланням на сторінку Godot API цього типу даних.
Центральна колонка містить назву властивості. Текст також є посиланням на повний опис цієї власності на сторінці. Використовуйте це ім’я, щоб отримати дані властивості або встановити для неї нове значення.
Правий стовпець містить стандартне значення властивості. Щоб ініціалізувати його іншим значенням, ви повинні встановити інше значення за допомогою сценарію або інспектора.
Методи
У таблиці «Методи» перераховано функції, які належать кожному екземпляру класу, також відомі як «методи»
Ліва колонка містить тип даних значення, яке повертає метод.
Правий стовпець містить назву, параметри та кваліфікатори методу. Ім'я - це текст перед відкриваючою дужкою. Це також посилання на повний опис методу на сторінці. Використовуйте це ім'я для виклику методу.
Для кожного параметра на сторінці детально описано тип даних, назву та значення за замовчуванням, якщо таке є.
Серед можливих кваліфікаторів...
const: метод не змінює жодних даних в екземплярі класу.virtual: метод нічого не робить, окрім очікування сценарію, щоб перевизначити його.vararg: метод може приймати довільну кількість аргументів.
Сигнали
Список Сигналів детально описує назви та параметри подій, які «сигналізують» про зміну стану гри іншим примірникам класу.
Подібно до таблиці «Методи», будь-які параметри включатимуть тип даних і назву.
Кожен сигнал також має детальне пояснення того, коли сигнал випромінюється.
Перерахування
У списку Enumeration деталізуються перелічувані типи даних, пов’язані з поточним класом.
Для кожного переліку на сторінці вказується його назва, а потім перераховуються його можливі значення.
Для кожного значення переліку на сторінці зазначається його назва, ціле значення та пояснення його варіантів використання та/або ефектів.
Константи
Список констант містить деталі, названі цілочисельними константами в поточному класі.
Для кожної константи на сторінці вказується її назва, ціле значення та пояснення варіантів використання та/або ефектів.
Описи констант NOTIFICATION_* вказуватимуть, яка подія двигуна викликає сповіщення.
Опис власності
У списку «Описи властивостей» детально описано все про кожну власність.
Він змінює тип даних і назву властивості.
Кожна властивість в Godot API прив’язана до пари установчих і приймальних функцій. Використання будь-якого є еквівалентним. Вони перераховані тут.
Нижче наведено детальний підсумок того, що представляють дані властивості, варіанти використання та/або наслідки їх зміни. Він може містити зразки коду та/або посилання на відповідні частини API Godot.
Примітка
Знати імена установщика та отримувача корисно, коли необхідно прив’язати назву методу або Callable до чогось.
Опис методів
У списку описів методів детально описано кожен метод.
Він повторює тип даних, що повертаються методом, назви параметрів/типи/за замовчуванням і кваліфікатори.
Нижче наведено детальний опис того, що робить метод, і варіанти його використання. Він може містити зразки коду та/або посилання на відповідні частини API Godot.