Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

PlayerSettings

Namespace: UnityEditor

/

Inherits from: Object

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Description

Player Settings is where you define various parameters for the final game that you will build in Unity. Some of these values are used in the Resolution Dialog that launches when you open a standalone game.

Static Variables

accelerometerFrequencyAccelerometer update frequency.
actionOnDotNetUnhandledExceptionSets the crash behavior on .NET unhandled exception.
advancedLicenseIs the advanced version being used?
allowedAutorotateToLandscapeLeftIs auto-rotation to landscape left supported?
allowedAutorotateToLandscapeRightIs auto-rotation to landscape right supported?
allowedAutorotateToPortraitIs auto-rotation to portrait supported?
allowedAutorotateToPortraitUpsideDownIs auto-rotation to portrait upside-down supported?
aotOptionsAdditional AOT compilation options. Shared by AOT platforms.
apiCompatibilityLevel.NET API compatibility level.
bakeCollisionMeshesPre bake collision meshes on player build.
bundleIdentifierApplication bundle identifier shared between iOS & Android platforms.
bundleVersionApplication bundle version shared between iOS & Android platforms.
captureSingleScreenDefines if fullscreen games should darken secondary displays.
cloudProjectIdA unique cloud project identifier. It is unique for every project (Read Only).
colorSpaceSet the color space for the current project.
companyNameThe name of your company.
d3d11FullscreenModeDefine how to handle fullscreen mode in Windows standalones (Direct3D 11 mode).
d3d9FullscreenModeDefine how to handle fullscreen mode in Windows standalones (Direct3D 9 mode).
defaultInterfaceOrientationDefault screen orientation for mobiles.
defaultIsFullScreenIf enabled, the game will default to fullscreen mode.
defaultScreenHeightDefault vertical dimension of stand-alone player window.
defaultScreenWidthDefault horizontal dimension of stand-alone player window.
defaultWebScreenHeightDefault vertical dimension of web player window.
defaultWebScreenWidthDefault horizontal dimension of web player window.
displayResolutionDialogDefines the behaviour of the Resolution Dialog on product launch.
enableCrashReportAPIEnables CrashReport API.
enableInternalProfilerEnables internal profiler.
firstStreamedLevelWithResourcesFirst level to have access to all Resources.Load assets in Streamed Web Players.
forceSingleInstanceRestrict standalone players to a single concurrent running instance.
gpuSkinningEnable GPU skinning on capable platforms.
iPhoneBundleIdentifierThe bundle identifier of the iPhone application.
keyaliasPassPassword for the key used for signing an Android application.
keystorePassPassword used for interacting with the Android Keystore.
locationUsageDescriptionDescribes the reason for access to the user's location data.
logObjCUncaughtExceptionsAre ObjC uncaught exceptions logged?
macFullscreenModeDefine how to handle fullscreen mode in Mac OS X standalones.
MTRenderingIs multi-threaded rendering enabled?
productNameThe name of your product.
renderingPathWhich rendering path is enabled?
resizableWindowUse resizable window in standalone player builds.
resolutionDialogBannerThe image to display in the Resolution Dialog window.
runInBackgroundIf enabled, your game will continue to run after lost focus.
showUnitySplashScreenShould the builtin Unity splash screen be shown?
statusBarHiddenShould status bar be hidden. Shared between iOS & Android platforms.
stereoscopic3DShould player render in stereoscopic 3d on supported hardware?
strippingLevelManaged code stripping level.
stripUnusedMeshComponentsShould unused Mesh components be excluded from game build?
targetIOSGraphicsiOS Graphics API.
use32BitDisplayBuffer32-bit Display Buffer is used.
useAnimatedAutorotationLet the OS autorotate the screen as the device orientation changes.
useDirect3D11Should Direct3D 11 be used when available?
useMacAppStoreValidationEnable receipt validation for the Mac App Store.
usePlayerLogWrite a log file with debugging information.
visibleInBackgroundOn Windows, show the application in the background if Fullscreen Windowed mode is used.
xboxDeployKinectHeadOrientationXbox 360 Kinect Head Orientation file deployment.
xboxDeployKinectHeadPositionXbox 360 Kinect Head Position file deployment.
xboxDeployKinectResourcesXbox 360 Kinect resource file deployment.
xboxEnableAvatarXbox 360 Avatars.
xboxEnableKinectXbox 360 Kinect title flag - if false, the Kinect APIs are inactive.
xboxEnableKinectAutoTrackingXbox 360 Kinect automatic skeleton tracking.
xboxEnableSpeechXbox 360 Kinect Enable Speech Engine.
xboxGenerateSpaXbox 360 auto-generation of _SPAConfig.cs.
xboxImageXexFilePathXbox 360 ImageXex override configuration file path.
xboxSpaFilePathXbox 360 SPA file path.
xboxSpeechDBXbox 360 Kinect Speech DB.
xboxSplashScreenXbox 360 splash screen.
xboxTitleIdXbox 360 title id.

Static Functions

GetIconsForTargetGroupReturns the list of assigned icons for the specified platform.
GetIconSizesForTargetGroupReturns a list of icon sizes for the specified platform.
GetPropertyBoolReturns a PlayerSettings named bool property (with an optional build target it should apply to).
GetPropertyIntReturns a PlayerSettings named int property (with an optional build target it should apply to).
GetPropertyOptionalBoolSearches for property and assigns it's value to given variable.
GetPropertyOptionalIntSearches for property and assigns it's value to given variable.
GetPropertyOptionalStringSearches for property and assigns it's value to given variable.
GetPropertyStringReturns a PlayerSettings named string property (with an optional build target it should apply to).
GetScriptingDefineSymbolsForGroupGet user-specified symbols for script compilation for the given build target group.
HasAspectRatioReturns whether or not the specified aspect ratio is enabled.
SetAspectRatioEnables the specified aspect ratio.
SetIconsForTargetGroupAssign a list of icons for the specified platform.
SetPropertyBoolSets a PlayerSettings named bool property.
SetPropertyIntSets a PlayerSettings named int property.
SetPropertyStringSets a PlayerSettings named string property.
SetScriptingDefineSymbolsForGroupSet user-specified symbols for script compilation for the given build target group.

Inherited members

Variables

hideFlagsShould the object be hidden, saved with the scene or modifiable by the user?
nameThe name of the object.

Public Functions

GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the game object.

Static Functions

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadMakes the object target not be destroyed automatically when loading a new scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares if two objects refer to the same.