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

Light Theme

Dark Theme

IOnlineSubsystemUtils

Interface class for various online utility functions

Windows

MacOS

Linux

References

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

Syntax

class IOnlineSubsystemUtils

Remarks

Interface class for various online utility functions

Constructors

	Name	Description
	IOnlineSubsystemUtils()	Hidden on purpose

Destructors

	Name	Description
	~IOnlineSubsystemUtils()

Functions

	Name	Description
TSharedPtr< ...	CreateForeignUniqueNetId ( const FString& Str, FName Type )	Create a TRANSPORT LAYER unique id NOTE: Do NOT Use this for anything other than replication to non native platforms This is NOT a shortcut for creating unique ids
int32	GetNumPIELogins()
FName	GetOnlineIdentifier ( const FWorldContext& WorldContext, const FName Subsystem )	Gets an FName that uniquely identifies an instance of OSS
FName	GetOnlineIdentifier ( const UWorld* World, const FName Subsystem )	Gets an FName that uniquely identifies an instance of OSS
void	GetPIELogins ( TArray< FOnlineAccountCredentials >... )
uint8	GetReplicationHashForSubsystem ( FName SubsystemName )	Return the replication hash for a given subsystem
FName	GetSubsystemFromReplicationHash ( uint8 InHash )	Return the name of the online subsystem associated with this hash
bool	IsOnlinePIEEnabled()
void	SetEngineExternalUIBinding ( const FOnExternalUIChangeDelegate&... )	Bind a notification delegate when any subsystem external UI is opened/closed NOTE there is only meant to be one delegate needed for this, game code should bind manually
void	SetShouldTryOnlinePIE ( bool bShouldTry )	Enable/Disable online PIE at runtime
bool	SupportsOnlinePIE()	Play in Editor settings

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

Take our survey

Dismiss