UEOSSettings

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

OnlineSubsystemEOS

Header

/Engine/Plugins/Online/OnlineSubsystemEOS/Source/OnlineSubsystemEOS/Public/EOSSettings.h

Include

#include "EOSSettings.h"

Syntax

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

Variables

Name Description

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

TArray< FArtifa...

 

Artifacts

Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

bool

 

bEnableOverlay

Set to true to enable the overlay (ecom features)

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

bool

 

bEnableSocialOverlay

Set to true to enable the social overlay (friends, invites, etc.)

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

bool

 

bMirrorAchievementsToEOS

Set to true to write achievement data to EOS as well as the default platform

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

bool

 

bMirrorPresenceToEAS

Set to true to have Epic Accounts presence information updated when the default platform is updated

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

bool

 

bMirrorStatsToEOS

Set to true to write stats to EOS as well as the default platform

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config displayname

bool

 

bShouldEnforceBeingLaunchedByEGS

Set to true to enable the social overlay (friends, invites, etc.)

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config displayname

bool

 

bUseEAS

Set to true to have Epic Accounts used (friends list will be unified with the default platform)

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config displayname

bool

 

bUseEOSConnect

Set to true to have EOS Connect APIs used to link accounts for crossplay

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config displayname

bool

 

bUseEOSSessions

Set to true to use EOS for session registration with data mirrored to the default platform

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

FString

 

CacheDir

The directory any PDS/TDS files are cached into.

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

FString

 

DefaultArtifactName

Used when launched from a store other than EGS or when the specified artifact name was not present

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

int32

 

TickBudgetInMilliseconds

Used to throttle how much time EOS ticking can take

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

int32

 

TitleStorageReadChunkLength

Chunk size used when reading a title file

Public variable UProperty Category, EditAnywhere BlueprintReadOnly Config

TArray< FString...

 

TitleStorageTags

Tag combinations for paged queries in title file enumerations, separate tags within groups using `+_

Functions

Name Description

Public function Static

FEOSSettings

 

GetSettings()

Public function Static

bool

 

GetSettingsForArtifact

(
    const FString& ArtifactName,
    FEOSArtifactSettings& OutSettings
)

Find the Settings for an artifact by name

Public function Const

FEOSSettings

 

ToNative()