Documentation Docs/en/reference/cmake/helpers.md

CMake Project Helpers

Generated reference. Do not edit this page directly. Update BuildTools/cmake/ProjectInterface.json, then run python BuildTools/docs_cmake.py --write.

Reference index

Canonical JSON model

Generation contract

These commands are the selected project-facing helper surface. Other commands under BuildTools/cmake remain internal unless they are added to the interface manifest.

Stable ID	Signature	Kind	Allowed roles	Source	Description
`cmake.helper.SetOption`	`SetOption(<name> <value>)`	`function`	-	BuildTools/Init.cmake	Set an embedding-project default only when the variable is not already defined.
`cmake.helper.AddStageHook`	`AddStageHook(<stage> <Pre\|Post> <macro-name>)`	`macro`	-	BuildTools/Init.cmake	Register a project macro at a stage boundary before that stage executes.
`cmake.helper.RegisterFindPackageHandler`	`RegisterFindPackageHandler(<package> <handler-macro>)`	`macro`	-	BuildTools/Init.cmake	Register the explicit package lookup handler used by the ThirdParty-stage find_package interceptor.
`cmake.helper.AddEngineSources`	`AddEngineSources(<role> <path-or-glob> [<role> <path-or-glob> ...])`	`macro`	`COMMON`, `SERVER`, `CLIENT`, `MAPPER`, `BAKER`, `TESTS`	BuildTools/cmake/helpers/Build.cmake	Add role-scoped embedding-project native sources before RegisterEngineSources.
`cmake.helper.AddNativeIncludeDir`	`AddNativeIncludeDir(<directory> [...])`	`macro`	-	BuildTools/cmake/helpers/Build.cmake	Add project-relative include directories when Native scripting is enabled.
`cmake.helper.AddBakingTarget`	`AddBakingTarget(<target> [SUB_CONFIG <name>] [FORCE] [COMMENT <text>])`	`function`	-	BuildTools/cmake/stages/ScriptsAndBaking.cmake	Create a project baking target with an optional subconfig, force mode, and build-hash update after SetupScriptsAndBaking.