Navigation
API > API/Plugins > API/Plugins/OnlineServicesCommon
| Name | TOnlineComponent |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/OnlineComponent.h |
| Include Path | #include "Online/OnlineComponent.h" |
Syntax
template<typename ComponentType>
class TOnlineComponent :
public ComponentType,
public UE::Online::IOnlineComponent
Inheritance Hierarchy
- ComponentType → TOnlineComponent
Derived Classes
TOnlineComponent derived class hierarchy
- FAchievementsCommon
- FAuthCommon
- FCommerceCommon
- FConnectivityCommon
- FEpicAccountIdResolverEOS
- FEpicProductUserIdResolverEOS
- FEpicProductUserIdResolverEOSGS
- FExternalUICommon
- FLeaderboardsCommon
- FLobbiesCommon
- FPlayerReportsEOSGS
- FPlayerSanctionsEOSGS
- FPresenceCommon
- FPrivilegesCommon
- FSessionsCommon
- FSocialCommon
- FStatsCommon
- FTitleFileCommon
- FUserFileCommon
- FUserInfoCommon
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Online/OnlineComponent.h | |||
TOnlineComponent
(
const TOnlineComponent& |
Online/OnlineComponent.h | ||
TOnlineComponent
(
const FString& ComponentName, |
Online/OnlineComponent.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Super | ComponentType | Online/OnlineComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExecCommands | TMap< FString, TUniquePtr< IOnlineExecHandler > > | Online/OnlineComponent.h | ||
| InterfaceName | FString | Online/OnlineComponent.h | ||
| PerUserSerialQueue | TMap< FAccountId, TUniquePtr< FOnlineAsyncOpQueueSerial > > | Online/OnlineComponent.h | ||
| SerialQueue | FOnlineAsyncOpQueueSerial | Online/OnlineComponent.h | ||
| WeakThis | TWeakPtr< ComponentType > | Online/OnlineComponent.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< ComponentType > AsShared () |
TSharedFromThis-like behavior. | Online/OnlineComponent.h | |
TSharedRef< ComponentType const > AsShared () |
Online/OnlineComponent.h | ||
| Online/OnlineComponent.h | |||
| Online/OnlineComponent.h | |||
bool Exec
(
UWorld* World, |
Online/OnlineComponent.h | ||
const FString & GetConfigName() |
Online/OnlineComponent.h | ||
| Online/OnlineComponent.h | |||
| Online/OnlineComponent.h | |||
TOnlineAsyncOpRef< OpType > GetJoinableOp
(
typename OpType::Params&& Params |
Online/OnlineComponent.h | ||
TOnlineAsyncOpRef< OpType > GetMergeableOp
(
typename OpType::Params&& Params |
Online/OnlineComponent.h | ||
TOnlineAsyncOpRef< OpType > GetOp
(
typename OpType::Params&& Params |
Online/OnlineComponent.h | ||
FOnlineAsyncOpQueue & GetSerialQueue
(
const FAccountId& AccountId |
Queues for executing per-user tasks in serial | Online/OnlineComponent.h | |
| Queue for executing tasks in serial | Online/OnlineComponent.h | ||
const ServicesType & GetServices () |
Online/OnlineComponent.h | ||
ServicesType & GetServices () |
Online/OnlineComponent.h | ||
bool Help
(
UWorld* World, |
Online/OnlineComponent.h | ||
bool LoadConfig
(
StructType& Struct, |
Online/OnlineComponent.h | ||
void RegisterCommand
(
InterfaceType* Interface, |
Default handler: generic parsing of Params, log Result. | Online/OnlineComponent.h | |
void RegisterCommand
(
T MemberFunction |
Default handler: generic parsing of Params, log Result. | Online/OnlineComponent.h | |
virtual void RegisterCommands() |
Online/OnlineComponent.h | ||
void RegisterExecHandler
(
const FString& Name, |
Custom handler. | Online/OnlineComponent.h |
Overridden from IOnlineComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize() |
Called after component has been constructed. It is not safe to reference other components at this time. | Online/OnlineComponent.h | |
virtual void PostInitialize() |
Called after all components have been initialized. | Online/OnlineComponent.h | |
virtual void PreShutdown() |
Called before any component has been shutdown. | Online/OnlineComponent.h | |
virtual void Shutdown() |
Called right before the component is destroyed. It is not safe to reference any other components at this time. | Online/OnlineComponent.h | |
virtual void Tick
(
float DeltaSeconds |
Called every Tick. | Online/OnlineComponent.h | |
virtual void UpdateConfig() |
Called whenever we need to reload data from config. | Online/OnlineComponent.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< OtherType const > SharedThis
(
const OtherType* ThisPtr |
Online/OnlineComponent.h | ||
static TSharedRef< OtherType > SharedThis
(
OtherType* ThisPtr |
Online/OnlineComponent.h |