Legacy Documentation: Version 5.3
LanguageEnglish
  • C#
  • JS

Script language

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

XboxOne

class in UnityEditor

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

Xbox One Specific Player Settings.

Static Variables

AllowedProductIdsGet the list of projects that can load this content package. This setting is only available for content packages.
AppManifestOverridePathXbox One optional parameter that lets you use a specified Manifest file rather than generated for you.
ContentIdXbox One Content ID to be used in constructing game package.
DescriptionA friendly description that can be displayed to users.
DisableKinectGpuReservationDisabling the kinect frees up additional GPU resources for use.
EnablePIXSamplingEnable sampling profiler in development builds to provide better profile markers for PIX, including Start and Update markers for script behaviors.
EnableRenderThreadRunsJobsTurns on the ability for the render thread to service the normal general purpose job queue while waiting for rendering related work. This is considered an advanced feature and users should only enable if they have a good understanding of their pix profile.
EnableVariableGPUTurns on notifications that you are gaining/losing GPU resources.
GameOsOverridePath(optional override) Location of Xbox One Game OS image file to link into ERA package being created.
IsContentPackageIndicates if the game is a standalone game or a content package to an existing game.
monoLoggingLevelThis option controls the mono trace log in XboxOne builds. This is a very verbose and expensive tool that can be used to help with debugging a potential mono issue.
PackageUpdateGranularityThe update granularity the package will be built with.
PackagingEncryptionXbox One optional parameter that causes the makepkg process to encrypt the package for performance testing or with final retail encryption.
PackagingOverridePathXbox One optional parameter that causes the makepkg process to use your specified layout file rather than generating one for you. Required if working with asset bundles.
PersistentLocalStorageSizeSets the size of the persistent local storage.
ProductIdXbox One Product ID to use when building a streaming install package.
SandboxIdXbox One makepkg option. Specifies the Sandbox ID to be used when building a streaming install package.
SCIDThe service configuration ID for your title.
SocketNamesGet the names of the socket descriptions for the project.
TitleIdThe TitleID uniquely identifying your title to Xbox Live services.
UpdateKeyXbox One makepkg.exe option. Specifies the update key required when building game updates.
VersionXbox One Version Identifier used in the Application Manifest.

Static Functions

AddAllowedProductIdAdd a ProductId to the list of products that can load the content package created from your project. This setting is only available for content packages.
GetCapabilityReturns a bool indicating if the given capability is enabled or not. Please see the XDK whitepaper titled "Xbox One Submission Validator" for valid capability names.
GetGameRatingGet the rating value that is specified in the appxmanifest.xml file for the given ratings board.
GetSocketDefinitionGet the values for the socket description with the given name.
RemoveAllowedProductIdRemove a ProductId from the list of products that can load the content package created from your project. This setting is only available for content packages.
RemoveSocketDefinitionRemove the socket description with the given name.
SetCapabilityMark a specific capability as enabled or enabled in the appxmanifest.xml file. Please see the XDK whitepaper titled "Xbox One Submission Validator" for valid capability names.
SetGameRatingSet the rating value that is specified in the appxmanifest.xml file.
SetSocketDefinitionSet the values for the socket description with the given name.
UpdateAllowedProductIdUpdate the value at the given index in the list of products that can load this content package. You can use the PlayerSettings.XboxOne.AllowedProductIds property to get the existing productIds and determine their indexes.