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...
Как читать API Godot
На этой странице вы узнаете, как читать справочник классов для API Godot.
API (Интерфейс Прикладного Программирования) — это каталог того, что Godot предлагает пользователям. Он содержит краткую информацию о существующих классах, их взаимосвязях, функциях и способах их использования.
Наследование
В верхней части каждого файла вы увидите название класса.
В разделе "Наследует" перечислены все классы, которые наследует текущий класс. Здесь CanvasItem наследует Node, а Node наследует Object.
В разделе "Inherited By" перечислены все классы, которые напрямую наследуют текущий класс. Здесь Control и Node2D оба наследуют CanvasItem.
Краткое описание
Далее следует краткое описание класса. Этот текст отображается во всплывающих окнах редактора Godot для создания Узлов (Nodes), Ресурсов (Resources) и других типов.
Описание
Далее следует более подробное описание класса, его особенностей и варианта(ов) использования.
Что вы можете здесь найти:
Особенности работы класса.
Примеры кода распространенных вариантов использования.
Подробности использования, которые являются общими для всех методов класса.
Предупреждения о необходимых зависимостях или конфигурации.
Ссылки на другие связанные части API Godot.
Уроки
Затем на странице приводятся ссылки на части руководства, в которых упоминается или используется текущий класс.
Свойства
В таблице "Properties (Свойства)" перечислены переменные, принадлежащие каждому экземпляру класса, также известные как "properties."
В левом столбце указан тип данных свойства. Текст также является ссылкой на страницу API Godot для этого типа данных.
В центральном столбце указано название свойства. Этот текст также является ссылкой на полное описание свойства на странице. Используйте это название, чтобы получить данные о свойстве или задать для него новое значение.
Правый столбец содержит значение свойства по умолчанию. Чтобы инициализировать его другим значением, необходимо задать другое значение через скрипт или Инспектор.
Методы
В таблице "Methods (Методы)" перечислены функции, принадлежащие каждому экземпляру класса, также известные как "methods."
Левый столбец содержит тип данных возвращаемого значения метода.
Правый столбец содержит имя, параметры и квалификаторы метода. Имя — это текст перед открывающейся скобкой. Оно также является ссылкой на полное описание метода на странице. Используйте это имя для вызова метода.
Для каждого параметра на странице указаны тип данных, имя и значение по умолчанию, если таковое имеется.
Возможные квалификаторы включают в себя...
const: метод не изменяет никаких данных в экземпляре класса.virtual: метод не делает ничего, кроме ожидания, пока скрипт его переопределит.vararg: метод может принимать произвольное количество аргументов.
Сигналы
В списке "Signals (Сигналы)" приводятся названия и параметры событий, которые "сигнализируют" об изменении состояния игры другим экземплярам класса.
Как и в таблице "Methods", все параметры будут включать тип данных и имя.
Каждый сигнал также сопровождается подробным объяснением момента его подачи.
Enumerations (Перечисления)
Список "Enumerations (Перечисления)" содержит подробные данные о перечисляемых типах данных, связанных с текущим классом.
Для каждого перечисления на странице указано его название, а затем перечислены его возможные значения.
Для каждого значения перечисления на странице указано его имя, его целочисленное значение и объяснение его варианта(ов) использования и/или влияния.
Константы
В списке "Constants (Константы)" содержатся именованные целочисленные константы в текущем классе.
Для каждой константы на странице указано ее имя, целочисленное значение и объяснение ее вариантов использования и/или влияний.
Описания констант NOTIFICATION_* будут указывать, какое событие движка запускает уведомление.
Property Descriptions (Описания недвижимости)
В списке Property Descriptions (Описания свойста) содержится подробная информация о каждом объекте свойства.
В нем повторно указывается тип данных и название свойства.
Каждое свойство в API Godot привязано к паре функций-сеттеров и геттеров. Использование любой из них равнозначно. Они перечислены здесь.
Ниже представлено подробное описание того, что представляют собой данные свойства, вариантов их использования и/или последствий их изменения. Оно может включать примеры кода и/или ссылки на соответствующие разделы API Godot.
Примечание
Знание имен setter и getter полезно, когда необходимо связать имя метода или Callable с чем-либо.
Method Descriptions (Описания методов)
В списке "Описания методов" подробно описан каждый метод.
В нем перечисляются возвращаемый методом тип данных, parameter names/types/defaults (имена параметров/типы/значения) по умолчанию и qualifiers (квалификаторы).
Ниже представлено подробное описание метода и вариантов его использования. Оно может включать примеры кода и/или ссылки на соответствующие разделы API Godot.