BuildOptions.DetailedBuildReport

Description

Generates detailed information in the UnityEditor.Build.Reporting.BuildReport.

The BuildReport object returned by BuildPipeline.BuildPlayer will contain additional data about build times and contents. This might lead to slightly longer build time, typically by a few percents.

The following script example illustrates how to use DetailedBuildReport when building a Player. Create a project and add the script under Assets/Editor.

1. Run the Build/DetailedBuildReport scripts example. 2. Access the information about the build process in the buildReport variable which you can process using the UnityEditor.Build.Reporting.BuildReport API. 3. Refer to the Build Report Inspector source script to find illustrations on how to query the UnityEditor.Build.Reporting.BuildReport API.

using UnityEditor;
using UnityEngine;

namespace BuildDocExamples
{
    public class BuildOptions_EditorExamples : MonoBehaviour
    {
        [MenuItem("BuildDocExamples/Build/Development and strict mode build")]
        public static void DevStrictModeBuild()
        {
            BuildPlayerOptions buildPlayerOptions = new BuildPlayerOptions();
            buildPlayerOptions.scenes = new[] { "Assets/scene.unity" };
            buildPlayerOptions.locationPathName = "scriptBuilds";
            buildPlayerOptions.target = BuildTarget.StandaloneOSX;

            // use these options for a development and strict mode build
            buildPlayerOptions.options = BuildOptions.Development | BuildOptions.StrictMode;

            BuildPipeline.BuildPlayer(buildPlayerOptions);
        }

        [MenuItem("BuildDocExamples/Build/Scripts only build")]
        public static void ScriptsOnlyBuild()
        {
            BuildPlayerOptions buildPlayerOptions = new BuildPlayerOptions();
            buildPlayerOptions.scenes = new[] { "Assets/scene.unity" };
            buildPlayerOptions.locationPathName = "scriptBuilds";
            buildPlayerOptions.target = BuildTarget.StandaloneOSX;

            // use these options for building scripts
            buildPlayerOptions.options = BuildOptions.BuildScriptsOnly | BuildOptions.Development;

            BuildPipeline.BuildPlayer(buildPlayerOptions);
        }

        [MenuItem("BuildDocExamples/Build/DetailedBuildReport build")]
        public static void DetailedBuildReportExample()
        {
            BuildPlayerOptions buildPlayerOptions = new BuildPlayerOptions();
            buildPlayerOptions.scenes = new[] { "Assets/scene.unity" };
            buildPlayerOptions.locationPathName = "DetailedReportBuild/MyGame.exe";
            buildPlayerOptions.target = BuildTarget.StandaloneWindows64;

            buildPlayerOptions.options = BuildOptions.DetailedBuildReport;

            var buildReport = BuildPipeline.BuildPlayer(buildPlayerOptions);
        }
    }
}