TOnlineComponent

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IOnlineComponent

TOnlineComponent

FAuthCommon

FAuthEOS

FConnectivityCommon

FExternalUICommon

FExternalUIEOS

FFriendsCommon

FFriendsEOS

FLobbiesCommon

FLobbiesEOS

FPresenceCommon

FPresenceEOS

FPrivilegesCommon

References

Module	OnlineServicesCommon
Header	/Engine/Plugins/Online/Experimental/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

		Name	Description
	FOnlineServices...	Services

Constructors

	Name	Description
	TOnlineComponent ( const TOnlineComponent& )
	TOnlineComponent ( TOnlineComponent&& )
	TOnlineComponent ( const FString& ComponentName, FOnlineServicesCommon& InServices )

Functions

	Name	Description
TSharedRef< ...	AsShared()
TSharedRef< ...	AsShared()	TSharedFromThis-like behavior.
bool	Exec ( UWorld* World, const TCHAR* Cmd, FOutputDevice& Ar )
const FStrin...	GetConfigName()
TArray< FStr...	GetConfigSectionHeiarchy ( const FString& OperationName )
TOnlineAsync...	GetJoinableOp ( typename OpType::Params&& Params )
TOnlineAsync...	GetMergeableOp ( typename OpType::Params&& Params )
TOnlineAsync...	GetOp ( typename OpType::Params&& Params )
FOnlineAsync...	GetSerialQueue()	Queue for executing tasks in serial
FOnlineAsync...	GetSerialQueue ( const FOnlineAccountIdHandle& Acco... )	Queues for executing per-user tasks in serial
const Servic...	GetServices()
ServicesType...	GetServices()
bool	LoadConfig ( StructType& Struct, const FString& OperationName )
void	RegisterCommand ( T MemberFunction )	Default handler: generic parsing of Params, log Result.
void	RegisterCommands()
void	RegisterExecHandler ( const FString& Name, TUniquePtr< IOnlineExecHandler >&&... )	Custom handler.
TSharedRef< ...	SharedThis ( const OtherType* ThisPtr )
TSharedRef< ...	SharedThis ( OtherType* ThisPtr )

Overridden from IOnlineComponent

	Name	Description
void	Initialize()	Called after component has been constructed. It is not safe to reference other components at this time.
void	LoadConfig()	Called whenever we need to reload data from config.
void	PostInitialize()	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.