UGDKTargetSettings

Implements the settings for the GDK target platform.

API > API/Developer > API/Developer/GDKPlatformEditor

Implements the settings for the GDK target platform. Note: Properties must use Config not GlobalConfig because the properties need to be serialized into the specialization's own ini file.

   
Name UGDKTargetSettings
Type class
Header File /Engine/Source/Developer/Microsoft/GDKPlatformEditor/Public/GDKTargetSettings.h
Include Path #include "GDKTargetSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Engine, defaultconfig, Abstract)  
class UGDKTargetSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGDKTargetSettings ( const FObjectInitializer& ObjectInitializer
)

   GDKTargetSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ApplicationBackgroundColor FColor Inform the OS what background color to use for your application tiles. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Content
ApplicationForegroundColor EGDKForegroundColor Inform the OS of what color scheme best contrasts with your application's tile images. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Content
  • Meta=(DisplayName="Application Foreground Text")
bAutoCreateDLCPackages bool When enabled, the DLC packages listed above will be generated automatically using `DLC Chunks_ during normal packaging. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=DLC
  • Meta=(DisplayName="Automatically Create DLC Packages (EXPERIMENTAL)")
bIncludeEngineVersionInPackageVersion bool Use Include the current engine changelist in the package version number. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • AdvancedDisplay
bUseFeaturesAndRecipes bool Whether to use simple On-Demand intelligent install chunks, or new Features and Recipes for defining chunks and installations GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category="Chunk Install"
bUseSimplifiedUserModel bool Whether to use the Simplified User Model where the OS will maintain a primary user for the title and the title will be terminated if this user signs out. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Features
CultureStringResources FGDKPackageStringResources The package default strings. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Content
CustomChunkMapping TArray< FGDKCustomChunkMapping > Define custom chunk mapping GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category="Chunk Install"
  • AdvancedDisplay
  • Meta=(TitleProperty="Pattern")
DefaultDisplayName FString Name of the product in Partner Center. Must match Partner Center configuration GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
DLCChunks TArray< FGDKDLCChunk > Chunks to pull out of the main package to include in DLC instead GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=DLC
  • Meta=(TitleProperty="ChunkId", DisplayName="DLC Chunks (EXPERIMENTAL)", EditCondition="bAutoCreateDLCPackages", EditConditionHides="true")
DLCPackages TArray< FGDKDLCPackage > Configuration for DLC packages. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=DLC
  • Meta=(TitleProperty="DLCName", DisplayName="DLC Packages (EXPERIMENTAL)")
DLCPlugins TArray< FGDKDLCPlugins > Configuration for DLC plugins GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=DLC
  • Meta=(TitleProperty="DLCName", DisplayName="DLC Plugins (EXPERIMENTAL)", EditCondition="!bAutoCreateDLCPackages", EditConditionHides="true")
IntelligentDeliveryChunks TArray< FGDKIntelligentDeliveryChunk > List of chunks. See the GDK documentation for details GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category="Chunk Install"
  • Meta=(TitleProperty="ChunkId")
IntelligentDeliveryFeatures TArray< FGDKIntelligentDeliveryFeature > List of features. See the GDK documentation for details GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category="Chunk Install"
  • Meta=(EditCondition="bUseFeaturesAndRecipes", TitleProperty="Id")
IntelligentDeliveryRecipes TArray< FGDKIntelligentDeliveryRecipe > List of recipes. See the GDK documentation for details GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category="Chunk Install"
  • Meta=(EditCondition="bUseFeaturesAndRecipes", TitleProperty="Id")
MSAAppId FString MSA App Id. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="MSA app Id"
PackageName FString Package/Identity/Name. Must match Partner Center configuration GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Package/Identity/Name"
PackageVersion FString Package version in the form 0.0.0.0 GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
PerCultureResources TArray< FGDKLocalizedPackageResources > The per culture images, icons, and strings describing a package. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Content
  • DisplayName="Per-Language Resources"
  • Meta=(TitleProperty="StageId")
PrimaryServiceConfigId FString Xbox Live Service Config Id (SCID). GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Xbox Services Configuration ID (SCID)"
ProductId FString Legacy Product GUID. Must match Partner Center configuration. Ignored if StoreId is specified GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Legacy Product ID"
  • Meta=(EditCondition="CanEditProductId()")
PublisherDisplayName FString Package/Properties/PublisherDisplayName. Must match Partner Center configuration GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Package/Properties/PublisherDisplayName"
PublisherName FString Package/Identity/Publisher. Must match Partner Center configuration GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Package/Identity/Publisher"
StageIdOverrides TMap< FString, FString > Mapping from "Languages To Package" in Packaging settings, to "Console-supported languages" in the GDK documentation. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Content
  • AdvancedDisplay
  • Meta=(GetKeyOptions="GetKnownCultureStageIds", DisplayName="Language/Locale Overrides")
StoreId FString Store Id. Must match Partner Center configuration. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Store ID"
TitleId FString Xbox Live Title Id. GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=PartnerCenter
  • DisplayName="Xbox Title ID"
UriActivationProtocols TArray< FGDKUriActivationProtocol > List of custom protocol schemes to register (March 2023 GDK onwards) GDKTargetSettings.h
  • EditAnywhere
  • Config
  • Category=Features
  • Meta=(TitleProperty="RegisteredProtocol", ForMSGameStore)

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanEditProductId()

   GDKTargetSettings.h  

TArray< FString > GetKnownCultureStageIds()

 UI helper function to get the list of known culture StageIDs, used by FGDKIntelligentDeliveryChunk. GDKTargetSettings.h  

TArray< FString > GetKnownDLCNames()

 UI helper function to get the list of DLC packages. GDKTargetSettings.h  

TArray< FString > GetKnownDLCPlugins()

 UI helper function to get the list of known DLC plugins. GDKTargetSettings.h  

TArray< FString > GetKnownIntelligentDeliveryFeatures()

 UI helper function to get the list of known features, used by FGDKIntelligentDeliveryRecipe. GDKTargetSettings.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual TArray< FString > GetKnownDeviceTypes()

 UI helper functions to get the list of known devices, used by FGDKIntelligentDeliveryRecipe & FGDKIntelligentDeliveryChunk. GDKTargetSettings.h  

virtual const TCHAR * GetPlatformName()

   GDKTargetSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page