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 > FOnlineSubsystemModule

Light Theme

Dark Theme

FOnlineSubsystemModule

Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

FOnlineSubsystemModule

References

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

Syntax

class FOnlineSubsystemModule : public IModuleInterface

Remarks

Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use

Constructors

	Name	Description
	FOnlineSubsystemModule()

Destructors

	Name	Description
	~FOnlineSubsystemModule()

Functions

	Name	Description
void	DestroyOnlineSubsystem ( const FName InSubsystemName )	Destroys an online subsystem created internally via access with GetOnlineSubsystem Typically destruction of the subsystem is handled at application exit, but there may be rare instances where the subsystem is destroyed by request
bool	DoesInstanceExist ( const FName InSubsystemName )	Does an instance of subsystem with the given name exist
void	EnumerateOnlineSubsystems ( FEnumerateOnlineSubsystemCb& EnumC... )
IOnlineSubsy...	GetNativeSubsystem ( bool bAutoLoad )	Get the online subsystem native to the current hardware
IOnlineSubsy...	GetOnlineSubsystem ( const FName InSubsystemName )	Main entry point for accessing an online subsystem by name Will load the appropriate module if the subsystem isn't currently loaded It's possible that the subsystem doesn't exist and therefore can return NULL
IOnlineSubsy...	GetSubsystemByConfig ( const FString& ConfigString, bool bAutoLoad )	Get the online subsystem associated with the given config string
bool	IsOnlineSubsystemLoaded ( const FName InSubsystemName )	Determine if a subsystem is loaded by the OSS module
void	RegisterPlatformService ( const FName FactoryName, IOnlineFactory* Factory )	Register a new online subsystem interface with the base level factory provider
void	ReloadDefaultSubsystem()	Shutdown the current default subsystem (may be the fallback) and attempt to reload the one specified in the configuration file
void	UnregisterPlatformService ( const FName FactoryName )	Unregister an existing online subsystem interface from the base level factory provider

Overridden from IModuleInterface

	Name	Description
void	PreUnloadCallback()	Called before the module has been unloaded Overloaded to allow online subsystems to cancel any outstanding http requests
void	ShutdownModule()	Called before the module is unloaded, right before the module object is destroyed.
void	StartupModule()	Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load
bool	SupportsAutomaticShutdown()	Override this to set whether your module would like cleanup on application shutdown
bool	SupportsDynamicReloading()	Override this to set whether your module is allowed to be unloaded on the fly

Typedefs

Name	Description
FEnumerateOnlineSubsystemCb	Enumerate all loaded online subsystems

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss