unreal.EOSSettings
¶
- class unreal.EOSSettings(outer=None, name='None')¶
Bases:
unreal.RuntimeOptionsBase
C++ Source:
Plugin: OnlineSubsystemEOS
Module: OnlineSubsystemEOS
File: EOSSettings.h
Editor Properties: (see get_editor_property/set_editor_property)
artifacts
(Array(ArtifactSettings)): [Read-Write] Artifacts: Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifactcache_dir
(str): [Read-Write] Cache Dir: The directory any PDS/TDS files are cached into. This is per artifact e.g.:<UserDir>/<ArtifactId>/<CacheDir>
default_artifact_name
(str): [Read-Write] Default Artifact Name: Used when launched from a store other than EGS or when the specified artifact name was not presentenable_overlay
(bool): [Read-Write] Enable Overlay: Set to true to enable the overlay (ecom features)enable_social_overlay
(bool): [Read-Write] Enable Social Overlay: Set to true to enable the social overlay (friends, invites, etc.)mirror_achievements_to_eos
(bool): [Read-Write] Mirror Achievements to EOS: Set to true to write achievement data to EOS as well as the default platformmirror_presence_to_eas
(bool): [Read-Write] Mirror Presence to EAS: Set to true to have Epic Accounts presence information updated when the default platform is updatedmirror_stats_to_eos
(bool): [Read-Write] Mirror Stats to EOS: Set to true to write stats to EOS as well as the default platformshould_enforce_being_launched_by_egs
(bool): [Read-Write] Should Enforce Being Launched by EGS: Set to true to enable the social overlay (friends, invites, etc.)tick_budget_in_milliseconds
(int32): [Read-Write] Tick Budget in Milliseconds: Used to throttle how much time EOS ticking can taketitle_storage_read_chunk_length
(int32): [Read-Write] Title Storage Read Chunk Length: Chunk size used when reading a title filetitle_storage_tags
(Array(str)): [Read-Write] Title Storage Tags: Tag combinations for paged queries in title file enumerations, separate tags within groups using +use_eas
(bool): [Read-Write] Use EAS: Set to true to have Epic Accounts used (friends list will be unified with the default platform)use_eos_connect
(bool): [Read-Write] Use EOSConnect: Set to true to have EOS Connect APIs used to link accounts for crossplayuse_eos_sessions
(bool): [Read-Write] Use EOSSessions: Set to true to use EOS for session registration with data mirrored to the default platform
- property artifacts¶
[Read-Only] Artifacts: Per artifact SDK settings. A game might have a FooStaging, FooQA, and public Foo artifact
- Type
- property cache_dir¶
[Read-Only] Cache Dir: The directory any PDS/TDS files are cached into. This is per artifact e.g.:
<UserDir>/<ArtifactId>/<CacheDir>
- Type
(str)
- property default_artifact_name¶
[Read-Only] Default Artifact Name: Used when launched from a store other than EGS or when the specified artifact name was not present
- Type
(str)
- property enable_overlay¶
[Read-Only] Enable Overlay: Set to true to enable the overlay (ecom features)
- Type
(bool)
- property enable_social_overlay¶
[Read-Only] Enable Social Overlay: Set to true to enable the social overlay (friends, invites, etc.)
- Type
(bool)
- property mirror_achievements_to_eos¶
[Read-Only] Mirror Achievements to EOS: Set to true to write achievement data to EOS as well as the default platform
- Type
(bool)
- property mirror_presence_to_eas¶
[Read-Only] Mirror Presence to EAS: Set to true to have Epic Accounts presence information updated when the default platform is updated
- Type
(bool)
- property mirror_stats_to_eos¶
[Read-Only] Mirror Stats to EOS: Set to true to write stats to EOS as well as the default platform
- Type
(bool)
- property should_enforce_being_launched_by_egs¶
[Read-Only] Should Enforce Being Launched by EGS: Set to true to enable the social overlay (friends, invites, etc.)
- Type
(bool)
- property tick_budget_in_milliseconds¶
[Read-Only] Tick Budget in Milliseconds: Used to throttle how much time EOS ticking can take
- Type
(int32)
- property title_storage_read_chunk_length¶
[Read-Only] Title Storage Read Chunk Length: Chunk size used when reading a title file
- Type
(int32)
- property title_storage_tags¶
[Read-Only] Title Storage Tags: Tag combinations for paged queries in title file enumerations, separate tags within groups using +
- property use_eas¶
[Read-Only] Use EAS: Set to true to have Epic Accounts used (friends list will be unified with the default platform)
- Type
(bool)