Navigation
API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online
Inheritance Hierarchy
- IOnlineComponent
- TOnlineComponent
- FAchievementsCommon
- FAchievementsEOSGS
- FAchievementsNull
- FAchievementsOSSAdapter
- FAuthCommon
- FAuthEOSGS
- FAuthEOS
- FAuthNull
- FAuthOSSAdapter
- FCommerceCommon
- FCommerceEOS
- FCommerceOSSAdapter
- FConnectivityCommon
- FConnectivityOSSAdapter
- FExternalUICommon
- FExternalUIEOS
- FExternalUIOSSAdapter
- FLeaderboardsCommon
- FLeaderboardsEOSGS
- FLeaderboardsNull
- FLeaderboardsOSSAdapter
- FLobbiesCommon
- FLobbiesEOSGS
- FLobbiesNull
- FPresenceCommon
- FPresenceEOS
- FPresenceNull
- FPresenceOSSAdapter
- FPrivilegesCommon
- FPrivilegesOSSAdapter
- FSessionsCommon
- FSessionsLAN
- FSessionsEOSGS
- FSessionsNull
- FSessionsOSSAdapter
- FSocialCommon
- FSocialEOS
- FSocialOSSAdapter
- FStatsCommon
- FStatsEOSGS
- FStatsNull
- FStatsOSSAdapter
- FTitleFileCommon
- FTitleFileEOSGS
- FTitleFileNull
- FTitleFileOSSAdapter
- FUserFileCommon
- FUserFileEOSGS
- FUserFileNull
- FUserFileOSSAdapter
- FUserInfoCommon
- FUserInfoEOS
- FUserInfoOSSAdapter
References
| Module | OnlineServicesCommon |
| Header | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/OnlineComponent.h |
| Include | #include "Online/OnlineComponent.h" |
Syntax
template<typename ComponentType>
class TOnlineComponent :
public ComponentType,
public UE::Online::IOnlineComponent
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FOnlineServicesCommon & | Services |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
TOnlineComponent
(
const TOnlineComponent& |
||
 |
|||
 |
TOnlineComponent
(
const FString& ComponentName, |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
TSharedRef< ComponentType const > | AsShared () |
|
 |
TSharedRef< ComponentType > | AsShared () |
TSharedFromThis-like behavior. |
  |
TWeakPtr< ComponentType const > | AsWeak () |
|
 |
TWeakPtr< ComponentType > | AsWeak () |
|
 |
bool | Exec
(
UWorld* World, |
|
  |
const FString & | ||
 |
TArray< FString > | GetConfigSectionHeiarchy
(
const FString& OperationName |
|
 |
TOnlineAsyncOpRef< OpType > | GetJoinableOp
(
typename OpType::Params&& Params |
|
 |
TOnlineAsyncOpRef< OpType > | GetMergeableOp
(
typename OpType::Params&& Params |
|
 |
TOnlineAsyncOpRef< OpType > | GetOp
(
typename OpType::Params&& Params |
|
 |
FOnlineAsyncOpQueue & | Queue for executing tasks in serial | |
 |
FOnlineAsyncOpQueue & | GetSerialQueue
(
const FAccountId& AccountId |
Queues for executing per-user tasks in serial |
  |
const ServicesType & | GetServices () |
|
 |
ServicesType & | GetServices () |
|
 |
bool | Help
(
UWorld* World, |
|
  |
bool | LoadConfig
(
StructType& Struct, |
|
 |
void | RegisterCommand
(
T MemberFunction |
Default handler: generic parsing of Params, log Result. |
  |
void | ||
 |
void | RegisterExecHandler
(
const FString& Name, |
Custom handler. |
  |
TSharedRef< OtherType const > | SharedThis
(
const OtherType* ThisPtr |
|
  |
TSharedRef< OtherType > | SharedThis
(
OtherType* ThisPtr |
Overridden from IOnlineComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | Initialize () |
Called after component has been constructed. It is not safe to reference other components at this time. |
  |
void | Called after all components have been initialized. | |
  |
void | PreShutdown () |
Called before any component has been shutdown. |
  |
void | Shutdown () |
Called right before the component is destroyed. It is not safe to reference any other components at this time. |
  |
void | Tick
(
float DeltaSeconds |
Called every Tick. |
  |
void | UpdateConfig () |
Called whenever we need to reload data from config. |
Typedefs
| Name | Description |
|---|---|
| Super |