1. Epic GamesDeveloper
  3. UEOSSettings

UEOSSettings

API > API/Plugins > API/Plugins/OnlineSubsystemEOS

   
Name UEOSSettings
Type class
Header File /Engine/Plugins/Online/OnlineSubsystemEOS/Source/OnlineSubsystemEOS/Public/EOSSettings.h
Include Path #include "EOSSettings.h"

Syntax

UCLASS (MinimalAPI, Config=Engine, defaultconfig)  
class UEOSSettings : public URuntimeOptionsBase

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Artifacts TArray< FArtifactSettings > Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
AuthScopeFlags TArray< FString > Auth scopes to request during login EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bEnableEditorOverlay bool Set to true to enable the overlay when running in the editor EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bEnableOverlay bool Set to true to enable the overlay (ecom features) EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bEnableSocialOverlay bool Set to true to enable the social overlay (friends, invites, etc.) EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bPreferPersistentAuth bool Set to true to prefer persistent auth over external authentication during Login EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bUseEAS bool Set to true to login to EOS_Auth (required to use Epic Account Services) EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
  • DisplayName="Login to EOS Auth, and use Epic Account Services"
bUseEOSConnect bool Set to true to login to EOS_Connect (required to use Epic Game Services) EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
  • DisplayName="Login to EOS Connect, and use EOS Game Services"
bUseEOSRTC bool Whether real-time chat is initialized when creating the EOS platform EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
  • DisplayName="Enable Real-Time chat"
bUseNamedPlatformConfig bool Set to true to use the IEOSSDKManager "named platform config" mechanism, rather than loading a config from OSSEOS ini. EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
bUseNewLoginFlow bool Set to true to use new EOS login flow EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Login Settings"
  • DisplayName="Use new Login flow, which doesn't rely on EOSPlus"
CacheDir FString The directory any PDS/TDS files are cached into. EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
DefaultArtifactName FString Used when launched from a store other than EGS or when the specified artifact name was not present EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
NintendoTokenType FString When running with Nintendo, defines what ExternalType will be used during ExternalAuth Login. EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Crossplay Settings"
PlatformConfigName FString When bUseNamedPlatformConfig is true, specifies the platform config name to use EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
RTCBackgroundMode FString The preferred background mode to be used by RTC services EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
SteamTokenType FString When running with Steam, defines what TokenType OSSEOS will request from OSSSteam to login with. EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Crossplay Settings"
TickBudgetInMilliseconds int32 Used to throttle how much time EOS ticking can take EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
TitleStorageReadChunkLength int32 Chunk size used when reading a title file EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"
TitleStorageTags TArray< FString > Tag combinations for paged queries in title file enumerations, separate tags within groups using `+_ EOSSettings.h
  • Config
  • EditAnywhere
  • BlueprintReadOnly
  • Category="EOS Settings"

Functions

Public

Name Remarks Include Path Unreal Specifiers

FEOSSettings ToNative()

   EOSSettings.h  

Static

Name Remarks Include Path Unreal Specifiers

static FEOSSettings AutoGetSettings()

   EOSSettings.h  

static bool GetArtifactSettings ( const FString& ArtifactName,
FEOSArtifactSettings& OutSettings
)

   EOSSettings.h  

static bool GetArtifactSettings ( const FString& ArtifactName,
const FString& SandboxId,
FEOSArtifactSettings& OutSettings
)

   EOSSettings.h  

static bool GetArtifactSettings ( const FString& ArtifactName,
const FString& SandboxId,
const FString& DeploymentId,
FEOSArtifactSettings& OutSettings
)

   EOSSettings.h  

static bool GetArtifactSettingsImpl ( const FString& ArtifactName,
const TOptional< FString >& SandboxId,
const TOptional< FString >& DeploymentId,
FEOSArtifactSettings& OutSettings
)

   EOSSettings.h  

static const TArray< FEOSArtifactSettings > & GetCachedArtifactSettings()

   EOSSettings.h  

static FString GetDefaultArtifactName()

   EOSSettings.h  

static bool GetSelectedArtifactSettings ( FEOSArtifactSettings& OutSettings
)

 Get the settings for the selected artifact EOSSettings.h  

static FEOSSettings GetSettings()

   EOSSettings.h  

static const FEOSSettings & ManualGetSettings()

   EOSSettings.h  

static void ModuleInit()

   EOSSettings.h  

static void ModuleShutdown()

   EOSSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page