Use build callbacks
Implement build callbacks to insert custom behavior into the Player build process.
阅读时间2 分钟最后更新于 8 天前
You can implement build callbacks to insert custom behavior into the Player build process. Unity invokes these callbacks whether you trigger the Player build from the Build Profiles window, from a custom menu, or from a command line build. Build callbacks are useful when adding custom build behavior for a package used across different Unity projects.
Supported callbacks
The following table lists the build callbacks that Unity supports:
Callback | Method | Description |
|---|---|---|
| | Add files and perform custom setup before the build starts. |
| | Called at the start of a build. |
| | Called at the end of the build. |
| | Remove assemblies from the build. |
| | Read or patch managed assemblies after compilation. |
| | Called while Unity processes each scene for the build. |
| | Filter the list of shader variants to reduce shader build times. |
| | Similar to |
| | Configure the managed code stripping stage of a Player build. |
| | Called if the Player is launched as a final step of the build. |
Player builds support all these callbacks. Content-only builds, which don't include managed assemblies, only invoke a subset: , , , and .
IPreprocessBuildWithContextIPostprocessBuildWithContextIProcessSceneWithReportIPreprocessComputeShadersCallback ordering
You can use to control the execution order of a build callback relative to other implementations of the same callback interface. Unity sorts the callbacks from lowest to highest order value, and you can assign any negative or positive integer value. For example, if your implementation of has an order value of 2, it runs after another callback that has an order value of 1.
IOrderedCallback.callbackOrderIPreprocessBuildWithContextIPreprocessBuildWithContextBuild callbacks during incremental builds
The following build callbacks happen during the content step of a Player build:
- Scene callbacks:
IProcessSceneWithReport.OnProcessScene - Shader callbacks: ,
IPreprocessShaders.OnProcessShaderIPreprocessComputeShaders.OnProcessComputeShader
When Unity reuses content from a previous build, it doesn't trigger these callbacks again because they already ran during the previous build. Unity caches any content change caused by the callback in the output from the previous build.
To ensure that Unity runs a modified callback implementation, perform a clean build, or modify the content of one of the scenes or assets in the build.
Other build callbacks that run before or after the content stage might trigger again during incremental builds. These callbacks must handle running multiple times on the same build output. For example, if a callback adds entries to an Android app manifest, it must check if those entries already exist to avoid creating an invalid manifest file.