| UObjectBase
|
Module |
|
Header |
/Engine/Source/Runtime/Engine/Public/Net/OnlineEngineInterface.h |
Include |
#include "Net/OnlineEngineInterface.h" |
class UOnlineEngineInterface : public UObject
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 | Description | |
---|---|---|
|
UOnlineEngineInterface ( |
Name | Description | ||
---|---|---|---|
|
AutoLogin ( |
Auto login a given player based on credentials specified on the command line |
|
|
BindToExternalUIOpening ( |
Bind a delegate to the opening/closing of an online platform's external UI |
|
|
ClearVoicePackets ( |
Clears all voice packets currently queued for send |
|
|
CloseWebURL() |
Closes the currently active web external UI |
|
|
TSharedPtr< ... |
CreateUniquePlayerId |
Identity |
|
DestroyOnlineSubsystem ( |
Destroy a given online subsystem |
|
|
DoesInstanceExist ( |
||
|
DoesSessionExist |
||
|
DumpChatState ( |
Dump chat state to the log |
|
|
DumpPartyState ( |
Dump party state to the log |
|
|
DumpSessionState ( |
DebugDump session state to the log |
|
|
DumpVoiceState ( |
Dump voice state to the log |
|
|
EndSession ( |
End a given named online session |
|
|
UOnlineEngin... |
Get() |
|
|
GetDefaultOnlineSubsystemName() |
Returns the name of the default online subsystem, generally the DefaultPlatformService config value. |
|
|
TSharedPtr< ... |
GetLocalPacket |
Voice |
|
GetNumLocalTalkers ( |
||
|
GetNumPIELogins() |
||
|
GetOnlineIdentifier ( |
||
|
GetPlayerNickname ( |
||
|
GetPlayerPlatformNickname |
||
|
GetReplicationHashForSubsystem ( |
Utils Return the replication hash for a given subsystem |
|
|
GetResolvedConnectString |
||
|
GetSessionJoinability ( |
||
|
GetSubsystemFromReplicationHash ( |
Return the name of the online subsystem associated with this hash |
|
|
TSharedPtr< ... |
GetUniquePlayerId |
|
|
IsLoaded ( |
Subsystem |
|
|
IsLoggedIn |
||
|
LoginPIEInstance ( |
Login a local user to the online subsystem before starting a Play In Editor (PIE) instance, using credentials stored in the editor |
|
|
MuteRemoteTalker ( |
Mute a remote user for a given local player |
|
|
RegisterPlayer ( |
Register a given player with the online session |
|
|
TSharedPtr< ... |
SerializeRemotePacket ( |
|
|
SetForceDedicated |
Force the online subsystem to treat itself like a dedicated server |
|
|
SetShouldTryOnlinePIE ( |
Enable/Disable online PIE at runtime |
|
|
ShowAchievementsUI |
Show an online external achievements UI if applicable to the platform |
|
|
ShowLeaderboardUI |
Show an online external leaderboard UI if applicable to the platform |
|
|
ShowWebURL ( |
Displays a web page in the external UI |
|
|
ShutdownOnlineSubsystem ( |
Shut down a given online subsystem |
|
|
StartNetworkedVoice |
Start processing networked voice traffic for a given local user |
|
|
StartSession ( |
SessionStart a given named online session |
|
|
StopNetworkedVoice |
Stop processing networked voice traffic for a given local user |
|
|
SupportsOnlinePIE() |
PIE Utilities |
|
|
UnmuteRemoteTalker ( |
UnMute a remote user for a given local player |
|
|
UnregisterPlayer ( |
Unregister a given player from the online session |
|
|
UnregisterPlayers ( |
||
|
UpdateSessionJoinability |
Name |
Description |
|
---|---|---|
|
FShowWebUrlParams |
External UI |
Name |
Description |
---|---|
Singleton |
One and only instance of this class, should handle normal and PIE operations by disambiguating in the function calls themselves |