Legacy Documentation: Version 2017.2 (Go to current version)
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.


class in UnityEditor

Suggest a change


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.


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.




User build settings for the Editor

Static Properties

activeBuildTargetThe currently active build target.
activeScriptCompilationDefinesDEFINE directives for the compiler.
allowDebuggingEnable source-level debuggers to connect.
androidBuildSubtargetAndroid platform options.
androidBuildSystemSet which build system to use for building the Android package.
buildScriptsOnlyIs build script only enabled.
compressFilesInPackageCompress files in package.
compressWithPsArcBuild data compressed with PSArc.
connectProfilerStart the player with a connection to the profiler.
developmentEnables a development build.
enableHeadlessModeEnables a Linux headless build.
explicitDivideByZeroChecksAre divide by zero's actively checked?
explicitNullChecksAre null references actively checked?
exportAsGoogleAndroidProjectExport Android Project for use with Android Studio/Gradle or Eclipse/ADT.
forceInstallationForce installation of package, even if error.
installInBuildFolderPlace the built player in the build folder.
iOSBuildConfigTypeScheme with which the project will be run in Xcode.
n3dsCreateCIAFileCreate a .cia "download image" for deploying to test kits (3DS).
needSubmissionMaterialsBuild submission materials.
ps4BuildSubtargetPS4 Build Subtarget.
ps4HardwareTargetSpecifies which version of PS4 hardware to target.
psmBuildSubtargetPSM Build Subtarget.
psp2BuildSubtargetPS Vita Build subtarget.
selectedBuildTargetGroupThe currently selected build target group.
selectedStandaloneTargetThe currently selected target for a standalone build.
streamingInstallLaunchRangeWhen building an Xbox One Streaming Install package (makepkg.exe) The layout generation code in Unity will assign each scene and associated assets to individual chunks. Unity will mark scene 0 as being part of the launch range, IE the set of chunks required to launch the game, you may include additional scenes in this launch range if you desire, this specifies a range of scenes (starting at 0) to be included in the launch set.
symlinkLibrariesSymlink runtime libraries with an iOS Xcode project.
tizenBuildSubtargetThe texture compression type to be used when building.
webGLUsePreBuiltUnityEngineUse prebuilt JavaScript version of Unity engine.
wiiUBootModeBoot mode of a devkit.
wiiUBuildDebugLevelWii U player debug level.
wiiuBuildOutputBuilt player postprocessing options.
wiiUEnableNetAPIEnable network API.
wsaGenerateReferenceProjectsGenerate and reference C# projects from your main solution.
wsaSubtargetSets and gets target device type for the application to run on when building to Windows Store platform.
wsaUWPSDKSets and gets target UWP SDK to build Windows Store application against.
xboxBuildSubtargetXbox Build subtarget.
xboxOneDeployMethodThe currently selected Xbox One Deploy Method.
xboxOneNetworkSharePathNetwork shared folder path e.g. MYCOMPUTER\SHAREDFOLDER\.
xboxOneRebootIfDeployFailsAndRetrySets the XBox to reboot and redeploy when the deployment fails.
xboxOneUsernameWindows account username associated with PC share folder.

Static Methods

GetBuildLocationGet the current location for the build.
GetPlatformSettingsReturns value for platform specifc Editor setting.
GetWSADotNetNativeIs .NET Native enabled for specific build configuration. More information - https://msdn.microsoft.com/en-us/library/dn584397(v=vs.110).aspx.
SetBuildLocationSet a new location for the build.
SetPlatformSettingsSet platform specifc Editor setting.
SetWSADotNetNativeEnables or Disables .NET Native for specific build configuration. More information - https://msdn.microsoft.com/en-us/library/dn584397(v=vs.110).aspx.
SwitchActiveBuildTargetSelect a new build target to be active.
SwitchActiveBuildTargetAsyncSelect a new build target to be active during the next Editor update.

Did you find this page useful? Please give it a rating: