Сгенерированный интерфейс проекта CMake
Сгенерированный справочник. Не редактируйте эту страницу напрямую. Обновите
BuildTools/cmake/ProjectInterface.json, затем выполнитеpython BuildTools/docs_cmake.py --write.
| Индекс справочника | Каноническая JSON-модель | Контракт генерации |
Этот справочник описывает доступную проекту поверхность CMake, которую использует подключающий игровой репозиторий. Manifest является проверяемой документационной моделью текущих объявлений CMake; во время конфигурации авторитетной остаётся реализация в BuildTools/Init.cmake и файлах стадий и helper-команд.
Статус контракта
| Поле | Значение |
|---|---|
| Стабильность | experimental |
| Начиная с версии | Не объявлено |
| Политика поддержки | Версионируемая линия поддержки пока не объявлена; подключающим проектам следует закреплять ревизию движка. |
| Исходный manifest | BuildTools/cmake/ProjectInterface.json |
Покрытие
| Справочник | Записи | Назначение |
|---|---|---|
| Параметры проекта | 45 | Обязательные входы, значения по умолчанию и приоритет переопределений. |
| Стадии и hooks | 10 | Строгий порядок генерации проекта и границы расширения. |
| Проектные helper-команды | 6 | Выбранные команды, предназначенные для подключающих проектов. |
Приоритет переопределения параметров
- соответствующая переменная окружения FO_
- существующее значение кеша CMake или -D
- значение SetOption, заданное подключающим проектом
- объявленное значение интерфейса по умолчанию
Побеждает первый определённый источник. Обязательные параметры не имеют значения интерфейса по умолчанию и должны быть заданы проектом.
Граница
Включено:
- параметры кеша проекта, объявленные на стадии Init
- упорядоченные точки входа стадий генерации проекта и hooks
- выбранные helper-команды подключающего проекта
Исключено из этого среза:
- внутренние helper-функции реализации CMake
- грамматика объявлений пакетов и схемы payload
- интерфейсы командной строки BuildTools
- файлы toolchain и политика платформенных presets
Объявления пакетов и payload описаны в отдельном справочнике интерфейса пакетов. Основная командная строка BuildTools описана в отдельном справочнике CLI на основе парсера.