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 artifactauth_scope_flags
(Array[str]): [Read-Write] Auth scopes to request during logincache_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 presentenable_editor_overlay
(bool): [Read-Write] Set to true to enable the overlay when running in the editorenable_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 platformmirror_presence_to_eas
(bool): [Read-Write] Set to true to have Epic Accounts presence information updated when the default platform is updatedmirror_stats_to_eos
(bool): [Read-Write] Set to true to write stats to EOS as well as the default platformshould_enforce_being_launched_by_egs
(bool): [Read-Write] Set to true to enable the social overlay (friends, invites, etc.)tick_budget_in_milliseconds
(int32): [Read-Write] Used to throttle how much time EOS ticking can taketitle_storage_read_chunk_length
(int32): [Read-Write] Chunk size used when reading a title filetitle_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 crossplayuse_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:
- 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 should_enforce_being_launched_by_egs: bool¶
[Read-Only] Set to true to enable the social overlay (friends, invites, etc.)
- Type:
(bool)
- 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 +
- 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)