Version: 2023.2
LanguageEnglish
  • C#

BuildPlayerOptions

struct in UnityEditor

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

Provide various options to control the behavior of BuildPipeline.BuildPlayer.

using UnityEditor;
using UnityEngine;

public class BuildPlayerOptionsExample { [MenuItem("Build/Log Build Settings")] public static void MyBuild() { // Log some of the current build options retrieved from the Build Settings Window BuildPlayerOptions buildPlayerOptions = BuildPlayerWindow.DefaultBuildMethods.GetBuildPlayerOptions(new BuildPlayerOptions()); Debug.Log("BuildPlayerOptions\n" + "Scenes: " + string.Join(",", buildPlayerOptions.scenes) + "\n" + "Build location: " + buildPlayerOptions.locationPathName + "\n" + "Options: " + buildPlayerOptions.options + "\n" + "Target: " + buildPlayerOptions.target); } }

Properties

assetBundleManifestPathThe path to an manifest file describing all of the asset bundles used in the build (optional).
extraScriptingDefinesUser-specified preprocessor defines used while compiling assemblies for the player.
locationPathNameThe path where the application will be built.
optionsAdditional BuildOptions, like whether to run the built player.
scenesThe Scenes to be included in the build.
subtargetThe Subtarget to build.
targetThe BuildTarget to build.
targetGroupThe BuildTargetGroup to build.