unreal.EOSSettings

class unreal.EOSSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: RuntimeOptionsBase

C++ Source:

  • Plugin: OnlineSubsystemEOS

  • Module: OnlineSubsystemEOS

  • File: EOSSettings.h

Editor Properties: (see get_editor_property/set_editor_property)

  • artifacts (Array[ArtifactSettings]): [Read-Write] Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact

  • auth_scope_flags (Array[str]): [Read-Write] Auth scopes to request during login

  • cache_dir (str): [Read-Write] The directory any PDS/TDS files are cached into. This is per artifact e.g.:

    <UserDir>/<ArtifactId>/<CacheDir>

  • default_artifact_name (str): [Read-Write] Used when launched from a store other than EGS or when the specified artifact name was not present

  • enable_editor_overlay (bool): [Read-Write] Set to true to enable the overlay when running in the editor

  • enable_overlay (bool): [Read-Write] Set to true to enable the overlay (ecom features)

  • enable_social_overlay (bool): [Read-Write] Set to true to enable the social overlay (friends, invites, etc.)

  • mirror_achievements_to_eos (bool): [Read-Write] Set to true to write achievement data to EOS as well as the default platform

  • mirror_presence_to_eas (bool): [Read-Write] Set to true to have Epic Accounts presence information updated when the default platform is updated

  • mirror_stats_to_eos (bool): [Read-Write] Set to true to write stats to EOS as well as the default platform

  • prefer_persistent_auth (bool): [Read-Write] Set to true to prefer persistent auth over external authentication during Login

  • rtc_background_mode (str): [Read-Write] The preferred background mode to be used by RTC services

  • steam_token_type (str): [Read-Write] When running with Steam, defines what TokenType OSSEOS will request from OSSSteam to login with. Please see EOS documentation at https://dev.epicgames.com/docs/dev-portal/identity-provider-management#steam for more information. Note the default is currently “Session” but this is deprecated. Please migrate to WebApi. Possible values:

    “App” -> [DEPRECATED] Use Steam Encryption Application Tickets from ISteamUser::GetEncryptedAppTicket. “Session” -> [DEPRECATED] Use Steam Auth Session Tickets from ISteamUser::GetAuthSessionTicket. “WebApi” -> Use Steam Auth Tickets from ISteamUser::GetAuthTicketForWebApi, using the default remote service identity configured for OSSSteam. “WebApi:<remoteserviceidentity>” -> Use Steam Auth Tickets from ISteamUser::GetAuthTicketForWebApi, using an explicit remote service identity.

  • tick_budget_in_milliseconds (int32): [Read-Write] Used to throttle how much time EOS ticking can take

  • title_storage_read_chunk_length (int32): [Read-Write] Chunk size used when reading a title file

  • title_storage_tags (Array[str]): [Read-Write] Tag combinations for paged queries in title file enumerations, separate tags within groups using +

  • use_eas (bool): [Read-Write] Set to true to have Epic Accounts used (friends list will be unified with the default platform)

  • use_eos_connect (bool): [Read-Write] Set to true to have EOS Connect APIs used to link accounts for crossplay

  • use_eos_sessions (bool): [Read-Write] Set to true to use EOS for session registration with data mirrored to the default platform

property artifacts: None

[Read-Only] Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact

Type:

(Array[ArtifactSettings])

property auth_scope_flags: None

[Read-Only] Auth scopes to request during login

Type:

(Array[str])

property cache_dir: str

[Read-Only] The directory any PDS/TDS files are cached into. This is per artifact e.g.:

<UserDir>/<ArtifactId>/<CacheDir>

Type:

(str)

property default_artifact_name: str

[Read-Only] Used when launched from a store other than EGS or when the specified artifact name was not present

Type:

(str)

property enable_editor_overlay: bool

[Read-Only] Set to true to enable the overlay when running in the editor

Type:

(bool)

property enable_overlay: bool

[Read-Only] Set to true to enable the overlay (ecom features)

Type:

(bool)

property enable_social_overlay: bool

[Read-Only] Set to true to enable the social overlay (friends, invites, etc.)

Type:

(bool)

property mirror_achievements_to_eos: bool

[Read-Only] Set to true to write achievement data to EOS as well as the default platform

Type:

(bool)

property mirror_presence_to_eas: bool

[Read-Only] Set to true to have Epic Accounts presence information updated when the default platform is updated

Type:

(bool)

property mirror_stats_to_eos: bool

[Read-Only] Set to true to write stats to EOS as well as the default platform

Type:

(bool)

property prefer_persistent_auth: bool

[Read-Only] Set to true to prefer persistent auth over external authentication during Login

Type:

(bool)

property rtc_background_mode: str

[Read-Only] The preferred background mode to be used by RTC services

Type:

(str)

property steam_token_type: str

[Read-Only] When running with Steam, defines what TokenType OSSEOS will request from OSSSteam to login with. Please see EOS documentation at https://dev.epicgames.com/docs/dev-portal/identity-provider-management#steam for more information. Note the default is currently “Session” but this is deprecated. Please migrate to WebApi. Possible values:

“App” -> [DEPRECATED] Use Steam Encryption Application Tickets from ISteamUser::GetEncryptedAppTicket. “Session” -> [DEPRECATED] Use Steam Auth Session Tickets from ISteamUser::GetAuthSessionTicket. “WebApi” -> Use Steam Auth Tickets from ISteamUser::GetAuthTicketForWebApi, using the default remote service identity configured for OSSSteam. “WebApi:<remoteserviceidentity>” -> Use Steam Auth Tickets from ISteamUser::GetAuthTicketForWebApi, using an explicit remote service identity.

Type:

(str)

property tick_budget_in_milliseconds: int

[Read-Only] Used to throttle how much time EOS ticking can take

Type:

(int32)

property title_storage_read_chunk_length: int

[Read-Only] Chunk size used when reading a title file

Type:

(int32)

property title_storage_tags: None

[Read-Only] Tag combinations for paged queries in title file enumerations, separate tags within groups using +

Type:

(Array[str])

property use_eas: bool

[Read-Only] Set to true to have Epic Accounts used (friends list will be unified with the default platform)

Type:

(bool)

property use_eos_connect: bool

[Read-Only] Set to true to have EOS Connect APIs used to link accounts for crossplay

Type:

(bool)

property use_eos_sessions: bool

[Read-Only] Set to true to use EOS for session registration with data mirrored to the default platform

Type:

(bool)