Внимание: Здесь драконы

Это последняя (нестабильная) версия документации, которая может содержать описание функций, недоступных в выпущенных стабильных версиях Godot или несовместимых с ними.

Вместо этого смотрите стабильную версию этой документации.

GDScript

Встроенные константы, функции и аннотации GDScript.

Описание

Список утилитных функций и аннотаций, специфичных для GDScript, доступных из любого скрипта.

Для списка глобальных функций и констант смотрите @GlobalScope.

Методики

В GDScript есть несколько встроенных методов и функций, которые упрощают многие аспекты разработки:

• Color:

Color8(r8: int, g8: int, b8: int, a8: int = 255)

Создает цвет из красного (r8), зеленого (g8), синего (b8) и, по желанию, альфа-канала (a8). Значения каналов должны быть целыми числами от 0 до 255.

• void:

assert(condition: bool, message: String = "")

Проверяет, истинно ли условие. Если нет, генерирует ошибку и останавливает выполнение проекта в режиме отладки.

• String:

char(char: int)

Возвращает символ в виде строки по его кодовой точке Unicode.

• Variant:

convert(what: Variant, type: int)

(Устарело) Преобразует значение в указанный тип.

• Object:

dict_to_inst(dictionary: Dictionary)

Преобразует словарь обратно в экземпляр объекта, полезно для десериализации.

• Array:

get_stack()

Возвращает массив словарей, представляющих текущий стек вызовов.

• Dictionary:

inst_to_dict(instance: Object)

Преобразует экземпляр объекта в словарь.

• bool:

is_instance_of(value: Variant, type: Variant)

Возвращает true, если значение является экземпляром указанного типа.

• int:

len(var: Variant)

Возвращает длину данного варианта (строки, массива или словаря).

• Resource:

load(path: String)

Возвращает ресурс из файловой системы по указанному пути.

• Resource:

preload(path: String)

Возвращает загруженный ресурс, который будет загружен при парсинге скрипта.

• void:

print_debug(...) vararg

Печатает отладочную информацию с учетом текущего стека.

• void:

print_stack()

Печатает трассировку стека в текущем местоположении кода.

• Array:

range(...) vararg

Возвращает массив с заданным диапазоном.

• bool:

type_exists(type: StringName)

Возвращает true, если данный класс существует в ClassDB.

Константы

• PI = 3.14159265358979: Константа, представляющая число Пи, используется в расчетах с кругами.
• TAU = 6.28318530717959: Константа, представляющая два Пи, или 360 градусов.
• INF = inf: Положительная бесконечность.
• NAN = nan: "Не число", обозначает недопустимое значение.

Аннотации

GDScript использует аннотации для управления экспортом свойств, их группировкой и другими аспектами. Вот несколько ключевых аннотаций:

• @export(): Помечает следующее свойство как экспортированное, что позволяет редактировать его в инспекторе.
• @export_category(name: String): Определяет новую категорию для следующих экспортированных свойств.
• @export_file(): Экспортирует свойство как путь к файлу с ограничением по типу.
• @export_group(name: String, prefix: String = ""): Определяет новую группу для следующих экспортируемых свойств, помогая организовать их в инспекторе.

Заключение

GDScript предлагает мощные инструменты и функции, которые позволяют разработчикам эффективно управлять проектами и создавать собственные игры. Добро пожаловать в мир разработки с Godot!