Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > OnlineSubsystem > FOnlineSubsystemImpl

Light Theme

Dark Theme

FOnlineSubsystemImpl

[FOnlineSubsystemImpl](API\Plugins\OnlineSubsystem\FOnlineSubsystemImpl) - common functionality to share across online platforms, not intended for direct use

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IOnlineSubsystem

FTSTickerObjectBase

FOnlineSubsystemImpl

FOnlineSubsystemAmazon

FOnlineSubsystemEOS

FOnlineSubsystemGoogleCommon

FOnlineSubsystemGoogle

FOnlineSubsystemNull

FOnlineSubsystemOculus

FOnlineSubsystemSteam

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystemImpl.h
Include	#include "OnlineSubsystemImpl.h"

Syntax

class FOnlineSubsystemImpl :
public IOnlineSubsystem,
public FTSTickerObjectBase

Remarks

FOnlineSubsystemImpl - common functionality to share across online platforms, not intended for direct use

Variables

	Name	Description
bool	bForceDedicated	Whether or not the online subsystem is in forced dedicated server mode
bool	bTickerStarted	Is the ticker started
TArray< FNextTi...	CurrentTickBuffer	Buffer to hold callbacks for the current tick (so it's safe to call ExecuteNextTick within a tick callback)
FName	InstanceName	Instance name (disambiguates PIE instances for example)
UNamedInterface...	NamedInterfaces	Holds all currently named interfaces
TQueue< FNextTi...	NextTickQueue	Queue to hold callbacks scheduled for next tick using ExecuteNextTick
FName	SubsystemName	Name of the subsystem

Constructors

	Name	Description
	FOnlineSubsystemImpl()	Hidden on purpose
	FOnlineSubsystemImpl ( FName InSubsystemName, FName InInstanceName )
	FOnlineSubsystemImpl ( FName InSubsystemName, FName InInstanceName, FTSTicker& Ticker )

Destructors

	Name	Description
	~FOnlineSubsystemImpl()

Functions

	Name	Description
void	ExecuteDelegateNextTick ( const FNextTickDelegate& Callback )	Queue a delegate to be executed on the next tick
void	ExecuteNextTick ( LAMBDA_TYPE&& Callback )	Templated helper for calling ExecuteDelegateNextTick with a lambda function
FString	FilterResponseStr ( const FString& ResponseStr, const TArray< FString >& RedactFie... )	Modify a response string so that it can be logged cleanly
void	InitNamedInterfaces()	Load in any named interfaces specified by the ini configuration
void	OnNamedInterfaceCleanup()	Delegate fired when named interfaces are cleaned up at exit
void	StartTicker()	Start Ticker
void	StopTicker()	Stop Ticker

Overridden from IOnlineSubsystem

	Name	Description
bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler that allows the online subsystem to process exec commands
IOnlineAchie...	GetAchievementsInterface()	Get the interface for accessing online achievements
IOnlineChatP...	GetChatInterface()	Get the interface for user-user and user-room chat functionality
IOnlineEntit...	GetEntitlementsInterface()	Get the interface for accessing user entitlements
IOnlineEvent...	GetEventsInterface()	Get the interface for accessing online achievements
IOnlineExter...	GetExternalUIInterface()	Get the interface for accessing the external UIs of a service
IOnlineGameA...	GetGameActivityInterface()	Get interface for accessing the game activity
IOnlineGameI...	GetGameItemStatsInterface()	Get interface for accessing the game item stats
IOnlineGameM...	GetGameMatchesInterface()	Get interface for accessing game matches
IOnlineGroup...	GetGroupsInterface()	IOnlineSubsystem.
IOnlineIdent...	GetIdentityInterface()	Get the interface for accessing identity online services
FName	GetInstanceName()	Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode.
IOnlineLeade...	GetLeaderboardsInterface()	Get the interface for accessing leaderboards/rankings of a service
IOnlineMessa...	GetMessageInterface()	Get the interface for accessing online messages
IMessageSani...	GetMessageSanitizer ( int32 LocalUserNum, FString& OutAuthTypeToExclude )	Get the interface for accessing the message sanitizer service
UObject *...	GetNamedInterface ( FName InterfaceName )	Get custom UObject data preserved by the online subsystem
EOnlineEnvir...	GetOnlineEnvironment()
FString	GetOnlineEnvironmentName()
IOnlineParty...	GetPartyInterface()	Get the interface for accessing the player party services
IOnlinePrese...	GetPresenceInterface()	Get the interface for managing rich presence information
IOnlinePurch...	GetPurchaseInterface()	Get the interface for purchasing
IOnlineShare...	GetSharedCloudInterface()	Get the interface for sharing user files in the cloud
IOnlineShari...	GetSharingInterface()	Get the interface for accessing online sharing
FText	GetSocialPlatformName()
IOnlineStats...	GetStatsInterface()	Get the interface for accessing online stats
IOnlineStore...	GetStoreV2Interface()	Get the interface for accessing an online store
FName	GetSubsystemName()	Return the name of the subsystem
IOnlineTimeP...	GetTimeInterface()	Get the interface for accessing the server time from an online service
IOnlineTitle...	GetTitleFileInterface()	Get the interface for accessing title file online services
IOnlineTourn...	GetTournamentInterface()	Get the interface for managing tournament information
IOnlineTurnB...	GetTurnBasedInterface()	Get the interface for managing turn based multiplayer games
IOnlineUserC...	GetUserCloudInterface()	Get the interface for accessing user files in the cloud
IOnlineUserP...	GetUserInterface()	Get the interface for accessing online user information
IOnlineVoice...	GetVoiceInterface()	Get the interface for accessing voice related data
bool	IsDedicated()	Is the online subsystem associated with the game/editor/engine running as dedicated.
bool	IsEnabled()
bool	IsLocalPlayer ( const FUniqueNetId& UniqueId )	Is a player local to this machine by unique id
bool	IsServer()	Is this instance of the game running as a server (dedicated OR listen) checks the Engine if possible for netmode status
void	PreUnload()	Perform any shutdown actions prior to any other modules being unloaded/shutdown
void	ReloadConfigs ( const TSet< FString >& ConfigSecti... )	Reload the configuration if it is relevant for this OSS instance
void	SetForceDedicated ( bool bForce )	Force the online subsystem to behave as if it's associated with running a dedicated server
void	SetNamedInterface ( FName InterfaceName, UObject* NewInterface )	Set a custom UObject to be preserved by the online subsystem
void	SetUsingMultiplayerFeatures ( const FUniqueNetId& UniqueId, bool bUsingMP )	Some platforms must know when the game is using Multiplayer features so they can do recurring authorization checks.
bool	Shutdown()	Shutdown the underlying subsystem APIs

Overridden from FTSTickerObjectBase

		Name	Description
	bool	Tick ( float DeltaTime )	FTSTickerObjectBase.

Constants

Name	Description
DefaultInstanceName	Name given to default OSS instances (disambiguates for PIE)