Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


PlayerSettings.WSA

Provides access to Microsoft Store App-specific player settings.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Class
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule
public sealed class PlayerSettings.WSA

Remarks

You can use these properties and methods to programmatically access Universal Windows Platform-specific build settings.

Static Properties

Property

Description

applicationDescriptionThe description text that the Microsoft Store displays with your application.
certificateIssuerThe certificate issuer for the current Universal Windows Platform certificate.
certificateNotAfterThe expiration date for the current Universal Windows Platform certificate.
certificatePathThe file path for the current Universal Windows Platform certificate.
certificateSubjectThe subject for the current Universal Windows Platform certificate.
defaultTileSizeThe tile size type to use as the default size for the application's tile.
inputSourceThe input source type for mouse, pen, and touch input events in a XAML app.
largeTileShowNameThe application name to display on the Large Tile.
lastRequiredSceneThe scene index number from the Scenes in Build list for the last scene that must be present in a Streaming Install build.
mediumTileShowNameThe application name to display on the Medium Tile.
packageNameThe name of the Universal Windows Platform application package to install on the device.
packageVersionThe version of the Universal Windows Platform application package to install on the device.
splashScreenBackgroundColorThe Override background color for the Unity splash screen.
supportStreamingInstallIndicates whether you can launch the Universal Windows Platform application package before installation is complete.
syncCapabilitiesSync the Capabilities set in the Unity Editor to the AppXManifest
tileBackgroundColorThe background color to use the application's tiles.
tileForegroundTextThe color style to use for the title text within the application's tile.
tileShortNameAn alternative, shorter title name to display in the application's tile.
tileShowNameIndicates which tiles display the application's display name.
transparentSwapchainSets AlphaMode on the swap chain to DXGI_ALPHA_MODE_PREMULTIPLIED.
vcxProjDefaultLanguageSets the XML value specified in the generated Visual Studio project file (.vcxproj). Applies only to the initial file generation, preexisting files will not be modified. When empty 'en-US' will be used.
wideTileShowNameIndicates whether to display the application name on the wide tile.

Static Methods

Method

Description

GetCapabilityChecks if the your project sets the specified UWP Capability.
GetTargetDeviceFamilyChecks if your project targets the specified device family.
GetVisualAssetsImageRetrieves the Asset path for the image you set as the Universal Windows Platform package logo.
SetCapabilityIncludes or removes the specified UWP Capability in the Universal Windows Platform build.
SetCertificateSets the certificate to use to sign the Universal Windows Platform application package.
SetTargetDeviceFamilyAdds or removes the specified UWP device family from the list of device families the Universal Windows Platform application build supports.
SetVisualAssetsImageSets the image to use as the Universal Windows Platform package logo.

Classes

Class

Description

PlayerSettings.WSA.DeclarationsRepresents additional Universal Windows Platform application settings written to the package manifest.