IOnlineSubsystemUtils

Interface class for various online utility functions

Choose your operating system:

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

Protected function

IOnlineSubsystemUtils()

Hidden on purpose

Destructors

Name Description

Public function Virtual

~IOnlineSubsystemUtils()

Functions

Name Description

Public function Const

FUniqueNetId...

 

CreateForeignUniqueNetId

(
    const FString& Str,
    FName Type
)

Create a TRANSPORT LAYER unique id

Public function Const

int32

 

GetNumPIELogins()

Public function Const

FName

 

GetOnlineIdentifier

(
    const FWorldContext& WorldContext,
    const FName Subsystem
)

Gets an FName that uniquely identifies an instance of OSS

Public function Const

FName

 

GetOnlineIdentifier

(
    const UWorld* World,
    const FName Subsystem
)

Gets an FName that uniquely identifies an instance of OSS

Public function

void

 

GetPIELogins

Public function Const

uint8

 

GetReplicationHashForSubsystem

(
    FName SubsystemName
)

Return the replication hash for a given subsystem

Public function Const

FName

 

GetSubsystemFromReplicationHash

(
    uint8 InHash
)

Return the name of the online subsystem associated with this hash

Public function Const

bool

 

IsOnlinePIEEnabled()

Public function

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

Public function

void

 

SetShouldTryOnlinePIE

(
    bool bShouldTry
)

Enable/Disable online PIE at runtime

Public function Const

bool

 

SupportsOnlinePIE()

Play in Editor settings