1. Epic GamesDeveloper
  3. UOnlineEngineInterface

UOnlineEngineInterface

Interface class between engine and OnlineSubsystem to remove dependencies between the two The real work is implemented in UOnlineEngineInterfaceImpl in OnlineSubsystemUtils The expectation is that this basic group of functions will not expand/change and that OnlineSubsystem can remain independent of the engine

API > API/Runtime > API/Runtime/Engine

Interface class between engine and OnlineSubsystem to remove dependencies between the two The real work is implemented in UOnlineEngineInterfaceImpl in OnlineSubsystemUtils The expectation is that this basic group of functions will not expand/change and that OnlineSubsystem can remain independent of the engine

Games should not use this interface, use the OnlineSubsystem plugins directly

Better functionality descriptions can be found in the OnlineSubsystem interfaces

Adding code here is discouraged, there is probably a better way, talk to the OGS team

   
Name UOnlineEngineInterface
Type class
Header File /Engine/Source/Runtime/Engine/Public/Net/OnlineEngineInterface.h
Include Path #include "Net/OnlineEngineInterface.h"

Syntax

UCLASS (Config=Engine, MinimalAPI)  
class UOnlineEngineInterface : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UOnlineEngineInterface ( const FObjectInitializer& ObjectInitializer
)

   Net/OnlineEngineInterface.h  

Structs

Name Remarks
FShowWebUrlParams External UI

Constants

Name Type Remarks Include Path
Singleton UOnlineEngineInterface * One and only instance of this class, should handle normal and PIE operations by disambiguating in the function calls themselves Net/OnlineEngineInterface.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AutoLogin ( UWorld* World,
int32 LocalUserNum,
const FOnlineAutoLoginComplete& InCompletionDelegate
)

 Auto login a given player based on credentials specified on the command line Net/OnlineEngineInterface.h  

virtual void BindToExternalUIOpening ( const FOnlineExternalUIChanged& Delegate
)

 Bind a delegate to the opening/closing of an online platform's external UI Net/OnlineEngineInterface.h  

virtual void ClearVoicePackets ( UWorld* World
)

 Clears all voice packets currently queued for send Net/OnlineEngineInterface.h  

virtual bool CloseWebURL()

 Closes the currently active web external UI Net/OnlineEngineInterface.h  

virtual FUniqueNetIdWrapper CreateUniquePlayerIdWrapper ( const FString& Str,
FName Type
)

 Identity Net/OnlineEngineInterface.h  

virtual void DestroyOnlineSubsystem ( FName OnlineIdentifier
)

 Destroy a given online subsystem Net/OnlineEngineInterface.h  

virtual bool DoesInstanceExist ( FName OnlineIdentifier
)

   Net/OnlineEngineInterface.h  

virtual bool DoesSessionExist ( UWorld* World,
FName SessionName
)

   Net/OnlineEngineInterface.h  

virtual void DumpChatState ( UWorld* World
)

 Dump chat state to the log Net/OnlineEngineInterface.h  

virtual void DumpPartyState ( UWorld* World
)

 Dump party state to the log Net/OnlineEngineInterface.h  

virtual void DumpSessionState ( UWorld* World
)

 Debug Dump session state to the log Net/OnlineEngineInterface.h  

virtual void DumpVoiceState ( UWorld* World
)

 Dump voice state to the log Net/OnlineEngineInterface.h  

virtual void EndSession ( UWorld* World,
FName SessionName,
FOnlineSessionEndComplete& InCompletionDelegate
)

 End a given named online session Net/OnlineEngineInterface.h  

virtual FName GetDefaultOnlineSubsystemName()

 Returns the name of the default online subsystem, generally the DefaultPlatformService config value. Net/OnlineEngineInterface.h  

virtual TSharedPtr< FVoicePacket > GetLocalPacket ( UWorld* World,
uint8 LocalUserNum
)

 Voice Net/OnlineEngineInterface.h  

virtual int32 GetNumLocalTalkers ( UWorld* World
)

   Net/OnlineEngineInterface.h  

virtual int32 GetNumPIELogins()

   Net/OnlineEngineInterface.h  

virtual FName GetOnlineIdentifier ( FWorldContext& WorldContext
)

   Net/OnlineEngineInterface.h  

virtual FString GetPIELoginCommandLineArgs ( int32 Index
)

   Net/OnlineEngineInterface.h  

virtual FString GetPlayerNickname ( UWorld* World,
const FUniqueNetIdWrapper& UniqueId
)

   Net/OnlineEngineInterface.h  

virtual bool GetPlayerPlatformNickname ( UWorld* World,
int32 LocalUserNum,
FString& OutNickname
)

   Net/OnlineEngineInterface.h  

virtual uint8 GetReplicationHashForSubsystem ( FName InSubsystemName
) const

 Utils Return the replication hash for a given subsystem Net/OnlineEngineInterface.h  

virtual bool GetResolvedConnectString ( UWorld* World,
FName SessionName,
FString& URL
)

   Net/OnlineEngineInterface.h  

virtual bool GetSessionJoinability ( UWorld* World,
FName SessionName,
FJoinabilitySettings& OutSettings
)

   Net/OnlineEngineInterface.h  

virtual FName GetSubsystemFromReplicationHash ( uint8 InHash
) const

 Return the name of the online subsystem associated with this hash Net/OnlineEngineInterface.h  

virtual FUniqueNetIdWrapper GetUniquePlayerIdWrapper ( UWorld* World,
int32 LocalUserNum,
FName Type
)

   Net/OnlineEngineInterface.h  

virtual bool IsCompatibleUniqueNetId ( const FUniqueNetIdWrapper& InUniqueNetId
) const

 Returns whether the unique net id is compatible Net/OnlineEngineInterface.h  

virtual bool IsLoaded ( FName OnlineIdentifier
)

 Subsystem Net/OnlineEngineInterface.h  

virtual bool IsLoggedIn ( UWorld* World,
int32 LocalUserNum
)

   Net/OnlineEngineInterface.h  

virtual void LoginPIEInstance ( FName OnlineIdentifier,
int32 LocalUserNum,
int32 PIELoginNum,
FOnPIELoginComplete& CompletionDelegate
)

 Login a local user to the online subsystem before starting a Play In Editor (PIE) instance, using credentials stored in the editor Net/OnlineEngineInterface.h  

virtual bool MuteRemoteTalker ( UWorld* World,
uint8 LocalUserNum,
const FUniqueNetIdWrapper& PlayerId,
bool bIsSystemWide
)

 Mute a remote user for a given local player Net/OnlineEngineInterface.h  

virtual void RegisterPlayer ( UWorld* World,
FName SessionName,
const FUniqueNetIdWrapper& UniqueId,
bool bWasInvited
)

 Register a given player with the online session Net/OnlineEngineInterface.h  

virtual TSharedPtr< FVoicePacket > SerializeRemotePacket ( UWorld* World,
const UNetConnection*const RemoteConnection,
FArchive& Ar
)

   Net/OnlineEngineInterface.h  

virtual void SetForceDedicated ( FName OnlineIdentifier,
bool bForce
)

 Force the online subsystem to treat itself like a dedicated server Net/OnlineEngineInterface.h  

virtual void SetShouldTryOnlinePIE ( bool bShouldTry
)

 Enable/Disable online PIE at runtime Net/OnlineEngineInterface.h  

virtual void ShowAchievementsUI ( UWorld* World,
int32 LocalUserNum
)

 Show an online external achievements UI if applicable to the platform Net/OnlineEngineInterface.h  

virtual void ShowLeaderboardUI ( UWorld* World,
const FString& CategoryName
)

 Show an online external leaderboard UI if applicable to the platform Net/OnlineEngineInterface.h  

virtual void ShowWebURL ( const FString& CurrentURL,
const FShowWebUrlParams& ShowParams,
const FOnlineShowWebUrlClosed& CompletionDelegate
)

 Displays a web page in the external UI Net/OnlineEngineInterface.h  

virtual void ShutdownOnlineSubsystem ( FName OnlineIdentifier
)

 Shut down a given online subsystem Net/OnlineEngineInterface.h  

virtual void StartNetworkedVoice ( UWorld* World,
uint8 LocalUserNum
)

 Start processing networked voice traffic for a given local user Net/OnlineEngineInterface.h  

virtual void StartSession ( UWorld* World,
FName SessionName,
FOnlineSessionStartComplete& InCompletionDelegate
)

 Session Start a given named online session Net/OnlineEngineInterface.h  

virtual void StopNetworkedVoice ( UWorld* World,
uint8 LocalUserNum
)

 Stop processing networked voice traffic for a given local user Net/OnlineEngineInterface.h  

virtual bool SupportsOnlinePIE()

 PIE Utilities Net/OnlineEngineInterface.h  

virtual bool UnmuteRemoteTalker ( UWorld* World,
uint8 LocalUserNum,
const FUniqueNetIdWrapper& PlayerId,
bool bIsSystemWide
)

 UnMute a remote user for a given local player Net/OnlineEngineInterface.h  

virtual void UnregisterPlayer ( UWorld* World,
FName SessionName,
const FUniqueNetIdWrapper& UniqueId
)

 Unregister a given player from the online session Net/OnlineEngineInterface.h  

virtual void UnregisterPlayers ( UWorld* World,
FName SessionName,
const TArray< FUniqueNetIdWrapper >& Players
)

 Unregister a given player from the online session Net/OnlineEngineInterface.h  

virtual void UpdateSessionJoinability ( UWorld* World,
FName SessionName,
bool bPublicSearchable,
bool bAllowInvites,
bool bJoinViaPresence,
bool bJoinViaPresenceFriendsOnly
)

   Net/OnlineEngineInterface.h  

Static

Name Remarks Include Path Unreal Specifiers

static UOnlineEngineInterface * Get()

   Net/OnlineEngineInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page