Navigation
API > API/Plugins > API/Plugins/OnlineSubsystemEOS
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- URuntimeOptionsBase
- UEOSSettings
References
| Module | OnlineSubsystemEOS |
| Header | /Engine/Plugins/Online/OnlineSubsystemEOS/Source/OnlineSubsystemEOS/Public/EOSSettings.h |
| Include | #include "EOSSettings.h" |
Syntax
UCLASS&40;Config&61;Engine, defaultconfig&41;
class UEOSSettings : public URuntimeOptionsBase
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FArtifactSettings > | Artifacts | Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact | |
| TArray< FString > | AuthScopeFlags | Auth scopes to request during login | |
| bool | bEnableEditorOverlay | Set to true to enable the overlay when running in the editor | |
| bool | bEnableOverlay | Set to true to enable the overlay (ecom features) | |
| bool | bEnableSocialOverlay | Set to true to enable the social overlay (friends, invites, etc.) | |
| bool | bMirrorAchievementsToEOS | Set to true to write achievement data to EOS as well as the default platform | |
| bool | bMirrorPresenceToEAS | Set to true to have Epic Accounts presence information updated when the default platform is updated | |
| bool | bMirrorStatsToEOS | Set to true to write stats to EOS as well as the default platform | |
| bool | bShouldEnforceBeingLaunchedByEGS | Set to true to enable the social overlay (friends, invites, etc.) | |
| bool | bUseEAS | Set to true to have Epic Accounts used (friends list will be unified with the default platform) | |
| bool | bUseEOSConnect | Set to true to have EOS Connect APIs used to link accounts for crossplay | |
| bool | bUseEOSSessions | Set to true to use EOS for session registration with data mirrored to the default platform | |
| FString | CacheDir | The directory any PDS/TDS files are cached into. | |
| FString | DefaultArtifactName | Used when launched from a store other than EGS or when the specified artifact name was not present | |
| int32 | TickBudgetInMilliseconds | Used to throttle how much time EOS ticking can take | |
| int32 | TitleStorageReadChunkLength | Chunk size used when reading a title file | |
| TArray< FString > | TitleStorageTags | Tag combinations for paged queries in title file enumerations, separate tags within groups using `+_ |
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | GetSelectedArtifactSettings
(
FEOSArtifactSettings& OutSettings |
Get the settings for the selected artifact | |
| FEOSSettings | GetSettings () |
||
| FEOSSettings | ToNative () |