IPreprocessBuildWithContext

Description

Implement this interface to execute code at the start of the Player build or AssetBundle build process.

At the start of a Player build or AssetBundle 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.

You can't invoke an additional build from inside this callback. To invoke an AssetBundle build at the start of a Player build use BuildPlayerProcessor.PrepareForBuild instead.

Example usages include:

• For validation checks, e.g. confirming required build settings, environmental variables, content or other project-specific conditions. When possible you can automatically fix problems by changing settings. Or you can fail the build, by throwing a BuildFailedException along with a clear error message.
• To make sure required Assets are included in the build. See PlayerSettings.SetPreloadedAssets.
• To generate version numbers, change logs, link.xml files or other content that should be regenerated prior to each Player build or AssetBundle build.
• For logging, reporting or sending analytics.

Build callbacks are a powerful feature, but when you implement them, it's important to maintain deterministic build outputs. For more information, refer to Use build callbacks.

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 might compromise the efficiency and accuracy of incremental builds or incremental upgrades.

The main difference between this interface and IPreprocessBuildWithReport or Build.IPreprocessBuild is that this callback gets called on AssetBundle builds and Player builds.

Additional resources: BuildPlayerProcessor.PrepareForBuild, IPostprocessBuildWithContext, BuildPlayerProcessor, BuildPipeline.BuildPlayer, BuildPipeline.BuildAssetBundles.

using System;
using UnityEditor.Build;

class BuildScheduleEnforcer : IPreprocessBuildWithContext
{
    public int callbackOrder { get { return 100; } }
    public void OnPreprocessBuild(BuildCallbackContext ctx)
    {
        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");
    }
}

Public Methods