BuildOptions
Options to configure a build. You can combine multiple build options together.
Read time 2 minutesLast updated 5 days ago
Definition
- Type: Enum
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
[Flags]public enum BuildOptions
Remarks
Additional Resources: BuildPipeline.BuildPlayer
Examples
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); } }}
Fields
Value | Description |
|---|---|
| AcceptExternalModificationsToPlayer | Appends to an existing Xcode (iOS) project during the build process. |
| AllowDebugging | Allow script debuggers to attach to the Player remotely. You can debug your scripts only if you use BuildOptions.Development. |
| AutoRunPlayer | Run the built Player. |
| BuildAdditionalStreamedScenes | For internal use |
| BuildScriptsOnly | Only build the scripts in a project. |
| CleanBuildCache | Clear all cached build results, resulting in a full rebuild of all scripts and all player data. |
| CompressWithLz4 | Use chunk-based LZ4 compression when building the Player. |
| CompressWithLz4HC | Use chunk-based LZ4 high-compression when building the Player. |
| ConnectToHost | Sets the Player to connect to the Editor. |
| ConnectWithProfiler | Start the Player with a connection to the Profiler in the Editor. |
| CustomConnectionID | Determines if the player should be using the custom connection ID. |
| DetailedBuildReport | Generates detailed information in the BuildReport. |
| Development | Build a development version of the Player. |
| EnableCodeCoverage | Enables code coverage. You can use this as a complimentary way of enabling code coverage on platforms that do not support command line arguments. |
| EnableDeepProfilingSupport | Enables Deep Profiling support in the Player. |
| ForceEnableAssertions | Include assertions in the build. By default, the assertions are only included in development builds. |
| IncludeTestAssemblies | Build will include Assemblies for testing. |
| None | Perform the specified build without any special settings or extra tasks. |
| NoUniqueIdentifier | Will force the buildGUID to all zeros. |
| PatchPackage | Patch a app package rather than completely rebuilding it. |
| ShowBuiltPlayer | Show the built Player. |
| StrictMode | Prevent the build from succeeding if any errors are reported during the build process. |
| SymlinkSources | Symlink sources when generating the project. This is useful if you're changing source files inside the generated project and want to bring the changes back into your Unity project or a package. |
| UncompressedAssetBundle | Don't compress the data when creating the asset bundle. |
| WaitForPlayerConnection | Sets the Player to wait for player connection on player start. |