interface in UnityEditor.Build
Implements interfaces:IOrderedCallback
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseImplement this interface to execute code at the start of the Player build process.
At the start of a Player build, Unity uses the IOrderedCallback.callbackOrder property on each implementation to determine the order in which to invoke the callbacks.
This callback can be useful for automated tasks and ensuring your build environment is correctly configured.
Example usages include:
Note: Build callbacks are a powerful feature, but it is strongly recommended that their implementations maintain deterministic build outputs.
The result of a build should be predictable and reproducible, based on the project’s content, the Unity version, and installed packages.
Introducing environment-specific behavior, external dependencies, randomness, or other non-deterministic elements can lead to outcomes
that are challenging to debug or reproduce. This unpredictability may also compromise the efficiency and accuracy of incremental builds or incremental upgrades.
Additional resources: BuildPlayerProcessor.PrepareForBuild, IPostprocessBuildWithReport, BuildPlayerProcessor, BuildPipeline.BuildPlayer.
using System; using UnityEditor.Build; using UnityEditor.Build.Reporting;
class BuildScheduleEnforcer : IPreprocessBuildWithReport { public int callbackOrder { get { return 100; } } public void OnPreprocessBuild(BuildReport report) { if (DateTime.Now.DayOfWeek == DayOfWeek.Thursday) // Force the build to fail. This message will appear in the console and Editor log. throw new BuildFailedException("No builds are allowed on Thursdays"); } }
OnPreprocessBuild | Implement this method to receive a callback before the build is started. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.