Version: 2020.2
LanguageEnglish
  • C#

BuildOptions.DetailedBuildReport

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Generates more information in the BuildReport.

The BuildReport object returned by BuildPipeline.BuildPlayer will contain more details (about build times and contents), at the cost of a slightly (typically, a few percents) longer build time.

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

using UnityEditor;
using UnityEngine;

public class DetailedBuildReportExample : MonoBehaviour { [MenuItem("Build/DetailedBuildReport example")] public static void MyBuild() { 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); } }

Now run the "Build/DetailedBuildReport example" scripts example.
You can now get more information about the build process in the variable "buildReport", that you can process using the BuildReport API.
You can find illustrations of how to query the BuildReport API by looking at the Build Report Inspector source script .