Документация Docs/ru/reference/cmake/helpers.md

Проектные helper-команды CMake

Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите BuildTools/cmake/ProjectInterface.json, затем выполните python BuildTools/docs_cmake.py --write.

Индекс справочника

Каноническая JSON-модель

Контракт генерации

Эти команды образуют выбранную поверхность helper-команд для проекта. Остальные команды в BuildTools/cmake остаются внутренними, пока не будут добавлены в manifest интерфейса.

Стабильный ID	Сигнатура	Вид	Допустимые роли	Источник	Описание
`cmake.helper.SetOption`	`SetOption(<name> <value>)`	`function`	-	BuildTools/Init.cmake	Задаёт значение подключающего проекта по умолчанию, только если переменная ещё не определена.
`cmake.helper.AddStageHook`	`AddStageHook(<stage> <Pre\|Post> <macro-name>)`	`macro`	-	BuildTools/Init.cmake	Регистрирует макрос проекта на границе стадии до её выполнения.
`cmake.helper.RegisterFindPackageHandler`	`RegisterFindPackageHandler(<package> <handler-macro>)`	`macro`	-	BuildTools/Init.cmake	Регистрирует явный обработчик поиска пакета, используемый перехватчиком find_package на стадии ThirdParty.
`cmake.helper.AddEngineSources`	`AddEngineSources(<role> <path-or-glob> [<role> <path-or-glob> ...])`	`macro`	`COMMON`, `SERVER`, `CLIENT`, `MAPPER`, `BAKER`, `TESTS`	BuildTools/cmake/helpers/Build.cmake	Добавляет нативные исходники подключающего проекта с разделением по ролям до RegisterEngineSources.
`cmake.helper.AddNativeIncludeDir`	`AddNativeIncludeDir(<directory> [...])`	`macro`	-	BuildTools/cmake/helpers/Build.cmake	Добавляет относительные к проекту каталоги include, когда включены нативные скрипты.
`cmake.helper.AddBakingTarget`	`AddBakingTarget(<target> [SUB_CONFIG <name>] [FORCE] [COMMENT <text>])`	`function`	-	BuildTools/cmake/stages/ScriptsAndBaking.cmake	Создаёт проектную цель запекания с необязательным subconfig, принудительным режимом и обновлением build hash после SetupScriptsAndBaking.