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

Unreal Engine C++ API Reference > Runtime > Engine > Net

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Net/OnlineEngineInterface.h
Include #include "Net/OnlineEngineInterface.h"

Syntax

class UOnlineEngineInterface : public UObject

Remarks

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

Constructors

  Type Name Description
Public function  

UOnlineEngineInterface ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual bool

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

 Auto login a given player based on credentials specified on the command line
Public function Virtual void

BindToExternalUIOpening ( const FOnlineExternalUIChanged& Delegate
)

 Bind a delegate to the opening/closing of an online platform's external UI
Public function Virtual void Clears all voice packets currently queued for send
Public function Virtual bool Closes the currently active web external UI
Public function Virtual FUniqueNetIdWrapper  
Public function Virtual void

DestroyOnlineSubsystem ( FName OnlineIdentifier
)

 Destroy a given online subsystem
Public function Virtual bool

DoesInstanceExist ( FName OnlineIdentifier
)

  
Public function Virtual bool

DoesSessionExist ( UWorld* World,
FName SessionName
)

  
Public function Virtual void

DumpChatState ( UWorld* World
)

 Dump chat state to the log
Public function Virtual void

DumpPartyState ( UWorld* World
)

 Dump party state to the log
Public function Virtual void DebugDump session state to the log
Public function Virtual void

DumpVoiceState ( UWorld* World
)

 Dump voice state to the log
Public function Virtual void

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

 End a given named online session
Public function Static UOnlineEngineInterface *

Get ()

  
Public function Virtual Const FName Returns the name of the default online subsystem, generally the DefaultPlatformService config value.
Public function Virtual TSharedPtr< FVoicePacket >

GetLocalPacket ( UWorld* World,
uint8 LocalUserNum
)

 Voice
Public function Virtual int32  
Public function Virtual int32  
Public function Virtual FName  
Public function Virtual FString

GetPlayerNickname ( UWorld* World,
const FUniqueNetIdWrapper& UniqueId
)

  
Public function Virtual bool

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

  
Public function Virtual Const uint8 Utils Return the replication hash for a given subsystem
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual Const FName Return the name of the online subsystem associated with this hash
Public function Virtual FUniqueNetIdWrapper

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

  
Public function Virtual Const bool

IsCompatibleUniqueNetId ( const FUniqueNetIdWrapper& InUniqueNetId
)

 Returns whether the unique net id is compatible
Public function Virtual bool

IsLoaded ( FName OnlineIdentifier
)

 Subsystem
Public function Virtual bool

IsLoggedIn ( UWorld* World,
int32 LocalUserNum
)

  
Public function 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
Public function Virtual bool

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

 Mute a remote user for a given local player
Public function Virtual void

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

 Register a given player with the online session
Public function Virtual TSharedPtr< FVoicePacket >

SerializeRemotePacket ( UWorld* World,
const UNetConnection*const RemoteConnection,
FArchive& Ar
)

  
Public function Virtual void

SetForceDedicated ( FName OnlineIdentifier,
bool bForce
)

 Force the online subsystem to treat itself like a dedicated server
Public function Virtual void

SetShouldTryOnlinePIE ( bool bShouldTry
)

 Enable/Disable online PIE at runtime
Public function Virtual void

ShowAchievementsUI ( UWorld* World,
int32 LocalUserNum
)

 Show an online external achievements UI if applicable to the platform
Public function Virtual void

ShowLeaderboardUI ( UWorld* World,
const FString& CategoryName
)

 Show an online external leaderboard UI if applicable to the platform
Public function Virtual void

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

 Displays a web page in the external UI
Public function Virtual void

ShutdownOnlineSubsystem ( FName OnlineIdentifier
)

 Shut down a given online subsystem
Public function Virtual void

StartNetworkedVoice ( UWorld* World,
uint8 LocalUserNum
)

 Start processing networked voice traffic for a given local user
Public function Virtual void

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

 SessionStart a given named online session
Public function Virtual void

StopNetworkedVoice ( UWorld* World,
uint8 LocalUserNum
)

 Stop processing networked voice traffic for a given local user
Public function Virtual bool PIE Utilities
Public function Virtual bool

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

 UnMute a remote user for a given local player
Public function Virtual void

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

 Unregister a given player from the online session
Public function Virtual void

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

 Unregister a given player from the online session
Public function Virtual void

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

  

Classes

  Type Name Description
Public struct FShowWebUrlParams External UI  

Constants

Name Description
Singleton One and only instance of this class, should handle normal and PIE operations by disambiguating in the function calls themselves

Deprecated Functions

  Type Name Description
Public function Virtual FUniqueNetIdPtr

CreateUniquePlayerId ( const FString& Str,
FName Type
)

 Use CreateUniquePlayerIdWrapper
Public function Virtual FString

GetPlayerNickname ( UWorld* World,
const FUniqueNetId& UniqueId
)

 Use GetPlayerNickname with FUniqueNetIdWrapper
Public function Virtual FUniqueNetIdPtr

GetUniquePlayerId ( UWorld* World,
int32 LocalUserNum,
FName Type
)

 Use GetUniquePlayerIdWrapper
Public function Virtual Const bool

IsCompatibleUniqueNetId ( const FUniqueNetId& InUniqueNetId
)

 Use IsCompatibleUniqueNetId with FUniqueNetIdWrapper
Public function Virtual bool

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

 Use MuteRemoteTalker with FUniqueNetIdWrapper
Public function Virtual void

RegisterPlayer ( UWorld* World,
FName SessionName,
const FUniqueNetId& UniqueId,
bool bWasInvited
)

 Use RegisterPlayer with FUniqueNetIdWrapper
Public function Virtual bool

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

 Use UnmuteRemoteTalker with FUniqueNetIdWrapper
Public function Virtual void

UnregisterPlayer ( UWorld* World,
FName SessionName,
const FUniqueNetId& UniqueId
)

 Use UnregisterPlayer with FUniqueNetIdWrapper
Public function Virtual void

UnregisterPlayers ( UWorld* World,
FName SessionName,
const TArray< FUniqueNetIdRef >& Players
)

 Use UnregisterPlayers with FUniqueNetIdWrapper

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page