Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

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

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

accelerometerFrequency Accelerometer update frequency.
advancedLicense Is the advanced version being used?
allowedAutorotateToLandscapeLeft Is auto-rotation to landscape left supported?
allowedAutorotateToLandscapeRight Is auto-rotation to landscape right supported?
allowedAutorotateToPortrait Is auto-rotation to portrait supported?
allowedAutorotateToPortraitUpsideDown Is auto-rotation to portrait upside-down supported?
aotOptions Additional AOT compilation options. Shared by AOT platforms.
apiCompatibilityLevel .NET API compatibility level.
bundleIdentifier Application bundle identifier shared between iOS & Android platforms.
bundleVersion Application bundle version shared between iOS & Android platforms.
captureSingleScreen Defines if fullscreen games should darken secondary displays.
colorSpace Set the color space for the current project.
companyName The name of your company.
d3d11ForceExclusiveMode Force exclusive mode in DirectX 11.
d3d9FullscreenMode Define how to handle fullscreen mode in Windows standalones (Direct3D 9 mode).
defaultInterfaceOrientation Default screen orientation for mobiles.
defaultIsFullScreen If enabled, the game will default to fullscreen mode.
defaultScreenHeight Default vertical dimension of stand-alone player window.
defaultScreenWidth Default horizontal dimension of stand-alone player window.
defaultWebScreenHeight Default vertical dimension of web player window.
defaultWebScreenWidth Default horizontal dimension of web player window.
displayResolutionDialog Defines the behaviour of the Resolution Dialog on product launch.
firstStreamedLevelWithResources First level to have access to all Resources.Load assets in Streamed Web Players.
forceSingleInstance Restrict standalone players to a single concurrent running instance.
gpuSkinning Enable GPU skinning on capable platforms.
iPhoneBundleIdentifier The bundle identifier of the iPhone application.
keyaliasPass Password for the key used for signing an Android application.
keystorePass Password used for interacting with the Android Keystore.
locationUsageDescription Describes the reason for access to the user's location data.
macFullscreenMode Define how to handle fullscreen mode in Mac OS X standalones.
MTRendering Is multi-threaded rendering enabled?
productName The name of your product.
ps3BackgroundPath PS3 Background Image.
ps3BootCheckMaxSaveGameSizeKB PS3 Bootcheck maximum savegame size ( as per TRC R224 ). This should include the total estimated size for the savegames (including icon sizes).
ps3DLCConfigPath PS3 DLC Config file.
ps3NpCommunicationPassphrase The Np Comminication passphrase to use when connecting to Playstation®Network.
ps3SaveGameSlots PS3 Save Game slots.
ps3SoundPath PS3 Background Sound.
ps3ThumbnailPath PS3 Thumbnail Image.
ps3TitleConfigPath PS3 Title Config file.
ps3TrialMode PS3 Title is Trial.
ps3TrophyCommId PS3 Trophy Communication ID.
ps3TrophyCommSig PS3 Trophy Communication Signature.
ps3TrophyPackagePath PS3 Trophy Package.
psp2BackgroundPath Deprecated.
psp2DLCConfigPath Deprecated.
psp2NPCommsID PS Vita NP Communications ID.
psp2NPCommsPassphrase PS Vita NP Passphrase.
psp2NPCommsSig PS Vita NP Signature.
psp2NPTrophyPackPath Path specifying wher to copy a trophy pack from.
psp2PackagePassword 32 character password for use if you want to access the contents of a package.
psp2ParamSfxPath Path specifying where to copy the package parameter file (param.sfx) from.
psp2SoundPath Deprecated.
psp2ThumbnailPath Deprecated.
psp2TrophyCommId Deprecated.
psp2TrophyPackagePath Deprecated.
renderingPath Which rendering path is enabled?
resizableWindow Use resizable window in standalone player builds.
resolutionDialogBanner The image to display in the Resolution Dialog window.
runInBackground If enabled, your game will continue to run after lost focus.
statusBarHidden Should status bar be hidden. Shared between iOS & Android platforms.
stereoscopic3D Should player render in stereoscopic 3d on supported hardware?
stripPhysics Remove Physics code from player to save build size (Flash only).
strippingLevel Managed code stripping level.
stripUnusedMeshComponents Should unused Mesh components be excluded from game build?
use32BitDisplayBuffer 32-bit Display Buffer is used.
useAnimatedAutorotation Let the OS autorotate the screen as the device orientation changes.
useDirect3D11 Should Direct3D 11 be used when available?
useMacAppStoreValidation Enable receipt validation for the Mac App Store.
usePlayerLog Write a log file with debugging information.
visibleInBackground On Windows, show the application in the background if Fullscreen Windowed mode is used.
xboxDeployKinectHeadOrientation Xbox 360 Kinect Head Orientation file deployment.
xboxDeployKinectHeadPosition Xbox 360 Kinect Head Position file deployment.
xboxDeployKinectResources Xbox 360 Kinect resource file deployment.
xboxEnableAvatar Xbox 360 Avatars.
xboxEnableKinect Xbox 360 Kinect title flag - if false, the Kinect APIs are inactive.
xboxEnableKinectAutoTracking Xbox 360 Kinect automatic skeleton tracking.
xboxEnableSpeech Xbox 360 Kinect Enable Speech Engine.
xboxGenerateSpa Xbox 360 auto-generation of _SPAConfig.cs.
xboxImageXexFilePath Xbox 360 ImageXex override configuration file path.
xboxSpaFilePath Xbox 360 SPA file path.
xboxSpeechDB Xbox 360 Kinect Speech DB.
xboxSplashScreen Xbox 360 splash screen.
xboxTitleId Xbox 360 title id.

Static Functions

GetIconsForTargetGroup Returns the list of assigned icons for the specified platform.
GetIconSizesForTargetGroup Returns a list of icon sizes for the specified platform.
GetScriptingDefineSymbolsForGroup Get user-specified symbols for script compilation for the given build target group.
HasAspectRatio Returns whether or not the specified aspect ratio is enabled.
SetAspectRatio Enables the specified aspect ratio.
SetIconsForTargetGroup Assign a list of icons for the specified platform.
SetScriptingDefineSymbolsForGroup Set user-specified symbols for script compilation for the given build target group.

Inherited members

Variables

hideFlags Should the object be hidden, saved with the scene or modifiable by the user?
name The name of the object.

Functions

GetInstanceID Returns the instance id of the object.
ToString Returns the name of the game object.

Static Functions

Destroy Removes a gameobject, component or asset.
DestroyImmediate Destroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoad Makes the object target not be destroyed automatically when loading a new scene.
FindObjectOfType Returns the first active loaded object of Type type.
FindObjectsOfType Returns a list of all active loaded objects of Type type.
Instantiate Clones the object original and returns the clone.

Operators

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