1. Epic GamesDeveloper
  3. OnlineServicesCommon

OnlineServicesCommon

API > API/Plugins

   
Name OnlineServicesCommon
Type Plugin
Part of Plugins Online Services
Location /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/
Module Build Rules OnlineServicesCommon.Build.cs

Classes

Name Remarks
FAccountInfoRegistry  
FAchievementsCommon  
FAuthCommon  
FCommerceCommon  
FConnectivityCommon  
FExternalUICommon  
FLeaderboardsCommon  
FLobbiesCommon  
FOnlineAsyncExecutionPolicy  
FOnlineAsyncOp  
FOnlineAsyncOpCache  
FOnlineAsyncOpQueue  
FOnlineAsyncOpQueueParallel  
FOnlineAsyncOpQueueSerial  
FOnlineComponentRegistry  
FOnlineConfigProviderGConfig IOnlineConfigProvider implementation that uses GConfig to retrieve values
FOnlineConfigStructGConfig  
FOnlineFunctionExecHandler Creates an exec handler for anything that can be stored in a TFunction
FOnlineOperationData  
FOnlineServicesCommon  
FOnlineSessionIdStringRegistry  
FOnlineSessionInviteIdStringRegistry  
FPresenceCommon  
FPrivilegesCommon  
FSchemaCategoryInstanceLobbySnapshotAccessor Accessor for using the public lobby attributes directly when committing schema changes.
FSessionCommon  
FSessionInviteCommon  
FSessionsCommon  
FSocialCommon  
FStatsCommon  
FTitleFileCommon  
FUserFileCommon  
FUserInfoCommon  
TDefaultErrorResult  
TDefaultErrorResultInternal For use when we need to put a TOnlineResult in an object that needs to be default constructed such as a TPromise
TForEachNStep  
TForEachStep  
TForEachStepBase  
TOnlineAnyData  
TOnlineAsyncOp There may be one or more handles pointing to one instance.
TOnlineAsyncOpBase Provides Then continuation for both TOnlineAsyncOp and TOnlineChainableAsyncOp.
TOnlineBasicIdRegistry A net id registry suitable for use with trivial immutable keys
TOnlineChainableAsyncOp  
TOnlineComponent  
TOnlineComponentExecHandler  
TOnlineInterfaceOperationExecHandler  
TOnlineMemberFunctionExecHandler Creates an exec handler that calls a class member function
TStep  

Structs

Name Remarks
CLocalAccountIdDefined  
COnlineGetTypeHashable Different than the standard CGetTypeHashable as we want to detect GetTypeHash using more than the standard name lookup rules.
FAchievementsCommonConfig  
FAchievementUnlockCondition  
FAchievementUnlockRule  
FFindUserStatsByAccountId  
FFunctionalTestLobbies  
FGetMutableSessionById  
FGetMutableSessionByName  
FLeaderboardDefinition  
FLeaderboardsCommonConfig  
FLobbyClientAttributeChanges  
FLobbyClientChanges Local changes to a lobby to be applied to the service.
FLobbyClientData Lobby data as seen by the client.
FLobbyClientDataCommitClientChanges  
FLobbyClientDataCommitServiceSnapshot  
FLobbyClientDataPrepareClientChanges  
FLobbyClientDataPrepareServiceSnapshot  
FLobbyClientMemberAttributeChanges  
FLobbyClientServiceChanges Local changes to a lobby translated to the changes which will be applied to the service.
FLobbyEvents  
FLobbyInternal Lobby data structure as seen by the client with additional fields for internal use.
FLobbyMemberInternal Lobby member data structure as seen by the client with additional fields for internal use.
FLobbyMemberServiceSnapshot Full snapshot of a lobby member.
FLobbyServiceSnapshot Full snapshot of lobby data excluding the individual member attributes
FOnOnlineAsyncOpCompletedParams Notification params of OnOnlineAsyncOpCompletedV2 delegate.
FOperationConfig  
FStatDefinition  
FStatsCommonConfig  
FWriteLeaderboardScores  
TContinuationResult  
TContinuationResultType  
TForEachNResultElementType Primary template with a dependent static_assert that only fails when instantiated.
TJoinableOpParamsFuncs  
TMergeableOpParamsFuncs MergeableOps Params contain a field of Mutations that implements operator+= that performs the merge.
TOnlineAsyncOpCallableTraits  
TOnlineAsyncOpCallableTraitsHelper  
TOnlineAsyncOpCallableTraitsHelper2  
TOnlineInterfaceOperationMemberFunctionPtrTraits  
TOnlineVariantVisitInfo  

Interfaces

Name Remarks
IOnlineAnyData  
IOnlineComponent  
IOnlineConfigProvider Interface for retrieving config values used by OnlineServices implementations
IOnlineConfigStruct  
IOnlineExecHandler  
IStep  

Typedefs

Name Type Remarks Include Path
FLobbiesSchemaCategoryInstance TSchemaCategoryInstance< FSchemaCategoryInstanceLobbySnapshotAccessor > Alias for schema category instance used by lobby and lobby member data. Online/LobbiesCommonTypes.h
FOnOnlineAsyncOpCompletedV2 TMulticastDelegate_OneParam< void, const FOnOnlineAsyncOpCompletedParams &Params > Notification that an online operation has completed Online/OnlineServicesCommonDelegates.h
IOnlineConfigStructPtr TSharedPtr< IOnlineConfigStruct >   Online/OnlineConfig.h
TContinuationResultType_T typename TContinuationResultType< T >::ResultType   Online/OnlineAsyncOp.h
TForEachNResultElementType_T typename TForEachNResultElementType< ResultType >::ResultElementType   Online/OnlineAsyncOp.h
TOnlineAsyncOpPtr TSharedPtr< TOnlineAsyncOp< OpType > >   Online/OnlineAsyncOp.h
TOnlineAsyncOpRef TSharedRef< TOnlineAsyncOp< OpType > >   Online/OnlineAsyncOp.h
TOnlineBasicAccountIdRegistry TOnlineBasicIdRegistry< OnlineIdHandleTags::FAccount, IdValueType >   Online/OnlineIdCommon.h
TOnlineBasicSessionIdRegistry TOnlineBasicIdRegistry< OnlineIdHandleTags::FSession, IdValueType >   Online/OnlineIdCommon.h
TOnlineBasicSessionInviteIdRegistry TOnlineBasicIdRegistry< OnlineIdHandleTags::FSessionInvite, IdValueType >   Online/OnlineIdCommon.h

Enums

Public

Name Remarks
UE::Online::ELeaderboardOrderMethod Serializes data in network byte order form into a buffer
UE::Online::ELeaderboardUpdateMethod Serializes data in network byte order form into a buffer
UE::Online::EOnlineAsyncExecutionPolicy Serializes data in network byte order form into a buffer
UE::Online::EOperationCacheExpirationPolicy Serializes data in network byte order form into a buffer
UE::Online::EStatModifyMethod Serializes data in network byte order form into a buffer

Constants

Name Type Remarks Include Path
UE::Online::CONNECT_STRING_TAG FName   Online/SessionsCommon.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

const DataType & UE::Online::GetOpDataChecked ( const TOnlineAsyncOp< OpType >& Op,
const FString& Key
)

   Online/OnlineUtilsCommon.h  

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

   Online/OnlineAsyncOpCache.h  

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

   Online/OnlineAsyncOpCache.h  

std::enable_if_t< TModels_V< Meta::COnlineMetadataAvailable, T >, bool > UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const FString& Section,
T& Value
)

 Populate a struct from a config provider. Online/OnlineConfig.h  

std::enable_if_t< TModels_V< Meta::COnlineMetadataAvailable, T >, bool > UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const TArray< FString >& SectionHeirarchy,
T& Value
)

 Populate a struct from a config provider. Online/OnlineConfig.h  

std::enable_if_t< TModels_V< Meta::COnlineMetadataAvailable, T >, bool > UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const FString& Section,
const TCHAR* Key,
T& OutValue
)

 Populate a struct from a config provider. Online/OnlineConfig.h  

std::enable_if_t< TModels_V< Meta::COnlineMetadataAvailable, T >, bool > UE::Online::LoadConfig ( IOnlineConfigProvider& Provider,
const TArray< FString >& SectionHeirarchy,
const TCHAR* Key,
T& Value
)

 Populate a struct from a config provider. Online/OnlineConfig.h  

TUniquePtr< IOnlineExecHandler > UE::Online::MakeExecHandler ( TFunction< bool(UWorld*, const TCHAR*, FOutputDevice&)>&& Function,
FString&& HelpString
)

 Creates an exec handler for anything that can be stored in a TFunction Online/OnlineExecHandler.h  

TUniquePtr< IOnlineExecHandler > UE::Online::MakeExecHandler ( T* Object,
bool(T::*)(UWorld*, const TCHAR*, FOutputDevice&) Function,
FString&& HelpString
)

 Creates an exec handler that calls a class member function Online/OnlineExecHandler.h  

FString UE::Online::ToLogString ( const TDefaultErrorResultInternal< T >& Result
)

   Online/OnlineAsyncOp.h  

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

 Todo: put this somewhere else. Online/LobbiesCommonTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page