PlayerSettings Inherits from UnityEngine.Object

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.

Note: This is an editor class. To use it you have to place your script in Assets/Editor inside your project folder. Editor classes are in the UnityEditor namespace so for C# scripts you need to add "using UnityEditor;" at the beginning of the script.

Class Variables
companyName

The name of your company.

productName

The name of your product.

colorSpace

Set the color space for the current project.

defaultScreenWidth

Default horizontal dimension of stand-alone player window.

defaultScreenHeight

Default vertical dimension of stand-alone player window.

defaultWebScreenWidth

Default horizontal dimension of web player window.

defaultWebScreenHeight

Default vertical dimension of web player window.

displayResolutionDialog

Defines the behaviour of the Resolution Dialog on product launch.

defaultIsFullScreen

If enabled, the game will default to fullscreen mode.

runInBackground

If enabled, your game will continue to run after lost focus.

captureSingleScreen

Defines if fullscreen games should darken secondary displays.

usePlayerLog

Write a log file with debugging information.

resizableWindow

Use resizable window in standalone player builds.

stripPhysics

Remove Physics code from player to save build size (Flash and NaCl only).

useMacAppStoreValidation

Enable receipt validation for the Mac App Store.

macFullscreenMode

Define how to handle fullscreen mode in Mac OS X standalones.

forceSingleInstance

Restrict standalone players to a single concurrent running instance.

resolutionDialogBanner

The image to display in the Resolution Dialog window.

iPhoneBundleIdentifier

The bundle identifier of the iPhone application.

keystorePass

Password used for interacting with the Android Keystore.

keyaliasPass

Password for the key used for signing an Android application.

xboxTitleId

Xbox 360 title id.

xboxImageXexFilePath

Xbox 360 ImageXex override configuration file path.

xboxSpaFilePath

Xbox 360 SPA file path.

xboxGenerateSpa

Xbox 360 auto-generation of _SPAConfig.cs.

xboxDeployKinectResources

Xbox 360 Kinect resource file deployment.

xboxDeployKinectHeadOrientation

Xbox 360 Kinect Head Orientation file deployment.

xboxDeployKinectHeadPosition

Xbox 360 Kinect Head Position file deployment.

xboxSplashScreen

Xbox 360 splash screen.

xboxAdditionalTitleMemorySize

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.

xboxSpeechDB

Xbox 360 Kinect Speech DB.

xboxSkinOnGPU

Xbox 360 GPU skinning.

xboxEnableAvatar

Xbox 360 Avatars.

ps3TitleConfigPath

PS3 Title Config file.

ps3DLCConfigPath

PS3 DLC Config file.

ps3ThumbnailPath

PS3 Thumbnail Image.

ps3BackgroundPath

PS3 Background Image.

ps3SoundPath

PS3 Background Sound.

ps3TrophyCommId

PS3 Trophy Communication ID.

ps3TrophyCommSig

PS3 Trophy Communication Signature.

ps3TrophyPackagePath

PS3 Trophy Package.

ps3BootCheckMaxSaveGameSizeKB

PS3 Bootcheck maximum savegame size ( as per TRC R224 ). This should include the total estimated size for the savegames (including icon sizes).

ps3TrialMode

PS3 Title is Trial.

ps3SaveGameSlots

PS3 Save Game slots.

bundleIdentifier

Application bundle identifier shared between iOS & Android platforms.

bundleVersion

Application bundle version shared between iOS & Android platforms.

statusBarHidden

Should status bar be hidden. Shared between iOS & Android platforms.

strippingLevel

Managed code stripping level.

defaultInterfaceOrientation

Default screen orientation for mobiles.

allowedAutorotateToPortrait

Is auto-rotation to portrait supported?

allowedAutorotateToPortraitUpsideDown

Is auto-rotation to portrait upside-down supported?

allowedAutorotateToLandscapeRight

Is auto-rotation to landscape right supported?

allowedAutorotateToLandscapeLeft

Is auto-rotation to landscape left supported?

useAnimatedAutorotation

Let the OS autorotate the screen as the device orientation changes.

use32BitDisplayBuffer

32-bit Display Buffer is used.

targetGlesGraphics

apiCompatibilityLevel

.NET API compatibility level.

stripUnusedMeshComponents

Should unused Mesh components be excluded from game build?

advancedLicense

Is the advanced version being used?

aotOptions

Additional AOT compilation options. Shared by AOT platforms.

accelerometerFrequency

Accelerometer update frequency.

MTRendering

Is multi-threaded rendering enabled?

renderingPath

Which rendering path is enabled?

useDirect3D11

Should Direct3D 11 be used when available?

Class Functions
HasAspectRatio

Returns whether or not the specified aspect ratio is enabled.

SetAspectRatio

Enables the specified aspect ratio.

GetIconsForTargetGroup

Returns the list of assigned icons for the specified platform.

SetIconsForTargetGroup

Assign a list of 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.

SetScriptingDefineSymbolsForGroup

Set user-specified symbols for script compilation for the given build target group.