EditorUserBuildSettings
User build settings for the Editor
Read time 7 minutesLast updated 4 days ago
Definition
- Type: Class
- Namespace: UnityEditor
- Assembly: UnityEditor.CoreModule
- Inherits from: Object
public class EditorUserBuildSettings : Object
Remarks
EditorUserBuildSettings tracks the build configuration for Player or AssetBundles builds. For example, the active build target is used to determine which platform the Player is built for.
This class is used to store build-related settings that are local to the project, as installed on a specific device. For example, EditorUserBuildSettings.activeBuildTarget is a setting that could have different values for different people who are using the same Unity project and simultaneously building the Player for different devices.
EditorUserBuildSettings is stored in , a location which is not intended for inclusion in version control. Some of these settings can be overridden by the active BuildProfile, see Override settings with build profiles for details.
Library/EditorUserBuildSettings.assetWhen writing a custom build script it is possible to retrieve the current settings using this class, or to provide different settings, see BuildPlayerOptions and BuildAssetBundlesParameters.
The related class EditorBuildSettings exposes build-related settings that are suitable to be backed up and shared through version control.
Static Properties
Property | Description |
|---|---|
| activeBuildTarget | The currently active build target. |
| activeScriptCompilationDefines | DEFINE directives for the compiler. |
| allowDebugging | Enable source-level debuggers to connect. |
| androidBuildSubtarget | Android platform options. |
| buildAppBundle | Set to true to build an Android App Bundle (aab file) instead of an apk. The default value is false. |
| buildScriptsOnly | Is build script only enabled. |
| buildWithCodeCoverage | Enables Code Coverage in the Player. |
| buildWithDeepProfilingSupport | Enables Deep Profiling support in the Player. |
| compressFilesInPackage | Compress files in package. |
| connectProfiler | Start the player with a connection to the profiler. |
| development | Enables a development build. |
| explicitArrayBoundsChecks | When true, array bounds are actively validated in code generated by IL2CPP. When false, they are not. |
| explicitDivideByZeroChecks | When true, divisions by zero are actively validated in code generated by IL2CPP. When false, they are not. |
| explicitNullChecks | When true, null references are actively validated in C++ generated by IL2CPP. When false, they are not. |
| exportAsGoogleAndroidProject | Export Android Project for use with Android Studio/Gradle. |
| forceInstallation | Force installation of package, even if error. |
| installInBuildFolder | Place the built player in the build folder. |
| iOSXcodeBuildConfig | The scheme Xcode uses to run this project. |
| macOSXcodeBuildConfig | The scheme Xcode uses to run this project. |
| managedDebuggerFixedPort | Force the port used by the managed debugger. Default is 0 which means platform-specific auto-selection of a port. |
| movePackageToDiscOuterEdge | Places the package on the outer edge of the disk. |
| needSubmissionMaterials | Build submission materials. |
| overrideMaxTextureSize | The override for the maximum texture size when importing assets. |
| overrideTextureCompression | The asset importing override of texture compression. |
| ps4BuildSubtarget | PS4 Build Subtarget. |
| ps4HardwareTarget | Specifies which version of PS4 hardware to target. |
| selectedBuildTargetGroup | The currently selected build target group. |
| selectedStandaloneTarget | The currently selected target for a standalone build. |
| standaloneBuildSubtarget | Desktop standalone build subtarget. |
| symlinkSources | Symlink sources when generating the project. |
| waitForManagedDebugger | Instructs the Player to wait for managed debugger to attach before executing any script code. |
| waitForPlayerConnection | Sets the Player to wait for player connection on player start. |
| webGLBuildSubtarget | WebGL Build subtarget. |
| webGLClientBrowserPath | The path to the executable of the browser in which to load the web application. |
| webGLClientBrowserType | Defines the client browser type in which to load the web application. |
| windowsBuildAndRunDeployTarget | Sets and gets the Windows device to launch the Windows app when using Build and Run. |
| windowsDevicePortalAddress | Specifies the Windows DevicePortal connection address of the device to deploy and launch the UWP app on when using Build and Run. |
| windowsDevicePortalPassword | Specifies the Windows DevicePortal password for the device to deploy and launch the UWP app on when using Build and Run. |
| windowsDevicePortalUsername | Specifies the Windows DevicePortal username for the device to deploy and launch the UWP app on when using Build and Run. |
| wsaBuildAndRunDeployTarget | Sets and gets the Windows device to launch the UWP app when using Build and Run. |
| wsaUWPBuildType | The build type for the Universal Windows Platform. |
| wsaUWPSDK | Sets and gets target UWP SDK to build Windows Store application against. |
| wsaUWPVisualStudioVersion | Sets and gets Visual Studio version to build Windows Store application with. |
Static Methods
Method | Description |
|---|---|
| GetBuildLocation | Returns the location used for the last saved build. |
| GetPlatformSettings | Returns value for platform-specific Editor setting. |
| SetBuildLocation | Set a new location for the build. |
| SetPlatformSettings | Set platform specifc Editor setting. |
| SwitchActiveBuildTarget | Select a new build target to be active. |
| SwitchActiveBuildTargetAsync | Select a new build target to be active during the next Editor update. |
Inheritance
Operators
Operator | Description |
|---|---|
| operator == | Compares two object references to see if they refer to the same object. |
| bool | Determines whether the object exists. |
| operator != | Compares if two objects refer to a different object. |