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 immediately after the Player build process is completed.
This is useful for tasks that need to be performed as the last step of building, such as cleaning up assets, generating analytics or reports, or customizing build outputs.
As a final step of a Player build, Unity uses the IOrderedCallback.callbackOrder property on each implementation to determine the order in which to invoke the callbacks.
Additional resources: IPreprocessBuildWithReport, BuildPipeline.BuildPlayer.
using System.Linq; using System.Text; using UnityEditor.Build; using UnityEditor.Build.Reporting; using UnityEngine;
// To try this example add this code into an Editor-only assembly, // run a Player build, and then look for the message in the console. // Note: if the build fails or is cancelled then the code will not run. class BuildPostProcessor : IPostprocessBuildWithReport { public int callbackOrder { get { return 100; } } public void OnPostprocessBuild(BuildReport report) { // Log some information from the BuildReport // Note: OnPostprocessBuild callbacks are invoked before the build is complete. // So the content of the BuildReport is not completely finalized. // For example, the summary.buildEndedAt has not been be determined, // and the incomplete "parent" BuildSteps still report 0 for their durations. var summary = report.summary;
var files = report.GetFiles(); ulong size = 0; foreach (var file in files) size += file.size;
var sb = new StringBuilder(); sb.AppendLine("Build completed"); sb.AppendLine($" Target: {summary.platform}"); sb.AppendLine($" Output Location: {summary.outputPath}"); sb.AppendLine($" Number of output files: {files.Length}"); sb.AppendLine($" Total size in bytes: {size}"); sb.AppendLine($" Starting time: {summary.buildStartedAt.ToLocalTime().ToShortTimeString()}"); sb.AppendLine();
var buildSteps = report.steps; sb.AppendLine($"Build steps: {buildSteps.Length}"); int maxWidth = buildSteps.Max(s => s.name.Length + s.depth) + 2; foreach (var step in buildSteps) { string rawStepOutput = new string('-', step.depth) + ' ' + step.name; sb.AppendLine($"{rawStepOutput.PadRight(maxWidth)}: {step.duration:g}"); }
Debug.Log(sb.ToString()); } }
OnPostprocessBuild | Implement this function to receive a callback after the build is complete. |
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.