1. Epic GamesDeveloper
  3. Online

Online

API > API/Plugins > API/Plugins/OnlineServicesCommon

Classes

  Type Name Description
Public struct CLocalAccountIdDefined    
Public struct COnlineGetTypeHashable Different than the standard CGetTypeHashable as we want to detect GetTypeHash using more than the standard name lookup rules.  
Public class FAccountInfoRegistry    
Public class FAchievementsCommon    
Public struct FAchievementsCommonConfig    
Public struct FAchievementUnlockCondition    
Public struct FAchievementUnlockRule    
Public class FAuthCommon    
Public class FCommerceCommon    
Public class FConnectivityCommon    
Public class FExternalUICommon    
Public struct FFindUserStatsByAccountId    
Public struct FFunctionalTestLobbies    
Public struct FGetMutableSessionById    
Public struct FGetMutableSessionByName    
Public struct FLeaderboardDefinition    
Public class FLeaderboardsCommon    
Public struct FLeaderboardsCommonConfig    
Public class FLobbiesCommon    
Public struct FLobbyClientAttributeChanges    
Public struct FLobbyClientChanges Local changes to a lobby to be applied to the service.  
Public struct FLobbyClientData Lobby data as seen by the client.  
Public struct FLobbyClientDataCommitClientChanges    
Public struct FLobbyClientDataCommitServiceSnapshot    
Public struct FLobbyClientDataPrepareClientChanges    
Public struct FLobbyClientDataPrepareServiceSnapshot    
Public struct FLobbyClientMemberAttributeChanges    
Public struct FLobbyClientServiceChanges Local changes to a lobby translated to the changes which will be applied to the service.  
Public struct FLobbyEvents    
Public struct FLobbyInternal Lobby data structure as seen by the client with additional fields for internal use.  
Public struct FLobbyMemberInternal Lobby member data structure as seen by the client with additional fields for internal use.  
Public struct FLobbyMemberServiceSnapshot Full snapshot of a lobby member.  
Public struct FLobbyServiceSnapshot Full snapshot of lobby data excluding the individual member attributes  
Public class FOnlineAsyncExecutionPolicy    
Public class FOnlineAsyncOp    
Public class FOnlineAsyncOpCache    
Public class FOnlineAsyncOpQueue    
Public class FOnlineAsyncOpQueueParallel    
Public class FOnlineAsyncOpQueueSerial    
Public class FOnlineComponentRegistry    
Public class FOnlineConfigProviderGConfig IOnlineConfigProvider implementation that uses GConfig to retrieve values  
Public class FOnlineConfigStructGConfig    
Public class FOnlineOperationData    
Public class FOnlineServicesCommon    
Public class FOnlineSessionIdStringRegistry    
Public class FOnlineSessionInviteIdStringRegistry    
Public struct FOperationConfig    
Public class FPresenceCommon    
Public class FPrivilegesCommon    
Public class FSchemaCategoryInstanceLobbySnapshotAccessor Accessor for using the public lobby attributes directly when committing schema changes.  
Public class FSessionCommon    
Public class FSessionInviteCommon    
Public class FSessionsCommon    
Public class FSocialCommon    
Public struct FStatDefinition    
Public class FStatsCommon    
Public struct FStatsCommonConfig    
Public class FTitleFileCommon    
Public class FUserFileCommon    
Public class FUserInfoCommon    
Public struct FWriteLeaderboardScores    
Public class IOnlineAnyData    
Public class IOnlineComponent    
Public class IOnlineConfigProvider Interface for retrieving config values used by OnlineServices implementations  
Public class IOnlineConfigStruct    
Public class IOnlineExecHandler    
Public class IStep    
Public class TDefaultErrorResult    
Public class TDefaultErrorResultInternal For use when we need to put a TOnlineResult in an object that needs to be default constructed such as a TPromise  
Public class TForEachNStep    
Public class TForEachStep    
Public class TForEachStepBase    
Public struct TJoinableOpParamsFuncs    
Public struct TMergeableOpParamsFuncs MergeableOps Params contain a field of Mutations that implements operator+= that performs the merge.  
Public class TOnlineAnyData    
Public class TOnlineAsyncOp There may be one or more handles pointing to one instance.  
Public class TOnlineAsyncOpBase Provides Then continuation for both TOnlineAsyncOp and TOnlineChainableAsyncOp.  
Public struct TOnlineAsyncOpCallableTraits    
Public struct TOnlineAsyncOpCallableTraitsHelper    
Public struct TOnlineAsyncOpCallableTraitsHelper2    
Public class TOnlineBasicIdRegistry A net id registry suitable for use with trivial immutable keys  
Public class TOnlineChainableAsyncOp    
Public class TOnlineComponent    
Public class TOnlineComponentExecHandler    
Public class TOnlineInterfaceOperationExecHandler    
Public struct TOnlineInterfaceOperationMemberFunctionPtrTraits    
Public struct TOnlineVariantVisitInfo    
Public class TStep    

Constants

Name Description
UE::Online::CONNECT_STRING_TAG  

Typedefs

Name Description
FLobbiesSchemaCategoryInstance Alias for schema category instance used by lobby and lobby member data.
IOnlineConfigStructPtr  
TOnlineAsyncOpPtr  
TOnlineAsyncOpRef  
TOnlineBasicAccountIdRegistry  
TOnlineBasicSessionIdRegistry  
TOnlineBasicSessionInviteIdRegistry  

Enums

  Type Name Description
Public enum UE::Online::ELeaderboardOrderMethod Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Online::ELeaderboardUpdateMethod Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Online::EOnlineAsyncExecutionPolicy Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Online::EOperationCacheExpirationPolicy Copyright Epic Games, Inc. All Rights Reserved.  
Public enum UE::Online::EStatModifyMethod Copyright Epic Games, Inc. All Rights Reserved.  

Functions

  Type Name Description
Public function uint32

UE::Online::GetTypeHash ( const FOnlineAsyncOpCache::FWrappedOperationKey& Key
)

  
Public function void

UE::Online::LexFromString ( EOperationCacheExpirationPolicy& Value,
const TCHAR*const String
)

  
Public function auto

UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const TArray< FString >& SectionHeirarchy,
const TCHAR* Key,
T& Value
)

 Populate a struct from a config provider.
Public function auto

UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const FString& Section,
const TCHAR* Key,
T& OutValue
)

 Populate a struct from a config provider.
Public function auto

UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const FString& Section,
T& Value
)

 Populate a struct from a config provider.
Public function auto

UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const TArray< FString >& SectionHeirarchy,
T& Value
)

 Populate a struct from a config provider.
Public function uint32  
Public function uint32 TArray GetTypeHash specialization used for TAsyncOpParamsFuncs::GetTypeHash
Public function bool

UE::Online::Private::LoadConfigStructMemberValue ( IOnlineConfigStruct& ConfigStruct,
const TCHAR* Key,
T& Value
)

  
Public function bool

UE::Online::Private::LoadConfigValue ( IOnlineConfigProvider& Provider,
const TCHAR* Section,
const TCHAR* Key,
T& Value
)

  
Public function std::enable_if_tMeta::COnlineMetadataAvailable, T >, bool >

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
T& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TOnlineId< IdType >& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TVariant< Ts... >& Variant,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool  
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TArray< T >& Array,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TOptional< T >& Optional,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TSharedRef< T >& Ref,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TSharedPtr< T >& Ptr,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TSet< T >& Set,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
TMap< T, U >& Map,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function std::enable_if_t< TModels_V< Meta::COnlineMetadataAvailable, T >, bool >

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
T& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
bool& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
uint8& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
int64& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
uint32& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
int32& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
FName& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
FString& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseOnlineExecParams ( const TCHAR*& Cmd,
uint64& Value,
IOnlineServices* Services
)

 Forward declarations for dependent type resolution.
Public function bool

UE::Online::Private::ParseTokenExt ( const TCHAR*& Str,
FString& Arg,
bool UseEscape,
bool bCommaSeparated,
bool bIncludeDelimiters
)

 Taken from FParse::Token, functionality added (possibly can be merged back?)
Public function T  
Public function TCHAR

UE::Online::Private::PeekNextChar ( const TCHAR* Cmd
)

  
Public function Static bool

UE::Online::Private::VisitVariantTypes ( VariantType& Variant,
FString& VariantPrefix,
FString& VariantValue,
IOnlineServices* Services
)

  
Public function bool

UE::Online::Private::VisitVariantTypes ( VariantType& Variant,
FString& VariantPrefix,
FString& VariantValue,
IOnlineServices* Services
)

  
Public function FString  
Public function TFuture< TArray< AwaitedType > >

UE::Online::WhenAll ( TArray< TFuture< AwaitedType >>&& Futures
)

 Todo: put this somewhere else.

Variables

  Type Name Description
Public variable constexpr bool MissingCase  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page