Language:
Discover
By Skill Level
By Category

IOnlineSubsystem

Choose your OS:

Inheritance Hierarchy

Syntax

class IOnlineSubsystem

Remarks

OnlineSubsystem - Series of interfaces to support communicating with various web/platform layer services

Variables

Name Description

Public variable

FOnConnectionSt ...

 

OnConnectionStatusChangedDelegates

Called when the connection state as reported by the online platform changes

Protected variable

FOnlineNotifica ...

 

OnlineNotificationHandler

Protected variable

FOnlineNotifica ...

 

OnlineNotificationTransportManager

Public variable

FOnOnlineEnviro ...

 

OnOnlineEnvironmentChangedDelegates

Delegate fired when the online environment changes

Public variable

FOnPlayTogether ...

 

OnPlayTogetherEventReceivedDelegates

Delegate fired when the "Play Together" event is sent from the PS4 system

Constructors

Name Description

Protected function

IOnlineSubsystem()

Hidden on purpose

Destructors

Name Description

Public function Virtual

~IOnlineSubsystem()

Functions

Name Description

Public function Virtual

FDelegateHan ...

 

AddOnConnectionStatusChangedDelegate_Handle

(
    const FOnConnectionStatusChangedDel ...
)

Public function Virtual

FDelegateHan ...

 

AddOnOnlineEnvironmentChangedDelegate_Handle

(
    const FOnOnlineEnvironmentChangedDe ...
)

Public function Virtual

FDelegateHan ...

 

AddOnPlayTogetherEventReceivedDelegate_Handle

(
    const FOnPlayTogetherEventReceivedD ...
)

Public function Virtual

void

 

ClearOnConnectionStatusChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnOnlineEnvironmentChangedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Virtual

void

 

ClearOnPlayTogetherEventReceivedDelegate_Handle

(
    FDelegateHandle & Handle
)

Public function Static

void

 

Destroy

(
    FName SubsystemName
)

Destroy a single online subsystem instance

Public function Static

bool

 

DoesInstanceExist

(
    const FName & SubsystemName
)

Determine if an instance of the subsystem already exists

Public function

bool

 

Exec

(
    UWorld * InWorld,
    const TCHAR * Cmd,
    FOutputDevice & Ar
)

Exec handler that allows the online subsystem to process exec commands

Public function Static

IOnlineSubsy ...

 

Get

(
    const FName & SubsystemName
)

Get the online subsystem for a given service

pointer to the appropriate online subsystem

Public function

IOnlineAchie ...

 

GetAchievementsInterface()

Get the interface for accessing online achievements

Public function

FString

 

GetAppId()

Each online subsystem has a global id for the app

the app id for this app

Public function Static

IOnlineSubsy ...

 

GetByConfig

(
    const FString & ConfigString,
    bool bAutoLoad
)

Get the online subsystem associated with the given config string

Public function Static

IOnlineSubsy ...

 

GetByPlatform

(
    bool bAutoLoad
)

Get the online subsystem native to the current hardware

Public function

IOnlineChatP ...

 

GetChatInterface()

Get the interface for user-user and user-room chat functionality

Public function

IOnlineEntit ...

 

GetEntitlementsInterface()

Get the interface for accessing user entitlements

Public function

IOnlineEvent ...

 

GetEventsInterface()

Get the interface for accessing online achievements

Public function

IOnlineExter ...

 

GetExternalUIInterface()

Get the interface for accessing the external UIs of a service

Public function

IOnlineFrien ...

 

GetFriendsInterface()

Get the interface for accessing the player friends services

Public function

IOnlineGroup ...

 

GetGroupsInterface()

Get the interface for accessing the groups services

Public function

IOnlineIdent ...

 

GetIdentityInterface()

Get the interface for accessing identity online services

Public function

FName

 

GetInstanceName()

Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode.

Public function

IOnlineLeade ...

 

GetLeaderboardsInterface()

Get the interface for accessing leaderboards/rankings of a service

Public function Static

FString

 

GetLocalPlatformName()

Get the local online platform based on compile time determination of hardware.

Public function

IOnlineMessa ...

 

GetMessageInterface()

Get the interface for accessing online messages

Public function

IMessageSani ...

 

GetMessageSanitizer

(
    int32 LocalUserNum,
    FString & OutAuthTypeToExclude
)

Get the interface for accessing the message sanitizer service

Public function

UObject *...

 

GetNamedInterface

(
    FName InterfaceName
)

Get custom UObject data preserved by the online subsystem

Public function

EOnlineEnvir ...

 

GetOnlineEnvironment()

The current environment being used for the online platform

Public function

FString

 

GetOnlineEnvironmentName()

The current environment being used for the online platform as defined by the platform (not necessarily EOnlineEnvironment::ToString )

Public function

FOnlineNotif ...

 

GetOnlineNotificationHandler()

Get the notification handler instance for this subsystem

Public function

FOnlineNotif ...

 

GetOnlineNotificationTransportManager()

Get the transport manager instance for this subsystem

Public function

FText

 

GetOnlineServiceName()

The name of the online service this platform uses

Public function

IOnlineParty ...

 

GetPartyInterface()

Get the interface for accessing the player party services

Public function

IOnlinePrese ...

 

GetPresenceInterface()

Get the interface for managing rich presence information

Public function

IOnlinePurch ...

 

GetPurchaseInterface()

Get the interface for purchasing

Interface pointer for the appropriate purchase service

Public function

IOnlineSessi ...

 

GetSessionInterface()

Get the interface for accessing the session management services

Public function

IOnlineShare ...

 

GetSharedCloudInterface()

Get the interface for sharing user files in the cloud

Public function

IOnlineShari ...

 

GetSharingInterface()

Get the interface for accessing online sharing

Public function

IOnlineStore ...

 

GetStoreInterface()

Get the interface for accessing an online store

Public function

IOnlineStore ...

 

GetStoreV2Interface()

Get the interface for accessing an online store

Public function

FName

 

GetSubsystemName()

Return the name of the subsystem

Public function

IOnlineTimeP ...

 

GetTimeInterface()

Get the interface for accessing the server time from an online service

Public function

IOnlineTitle ...

 

GetTitleFileInterface()

Get the interface for accessing title file online services

Public function

IOnlineTourn ...

 

GetTournamentInterface()

Get the interface for managing tournament information

Public function

IOnlineTurnB ...

 

GetTurnBasedInterface()

Get the interface for managing turn based multiplayer games

Public function

IOnlineUserC ...

 

GetUserCloudInterface()

Get the interface for accessing user files in the cloud

Public function

IOnlineUserP ...

 

GetUserInterface()

Get the interface for accessing online user information

Public function

IOnlineVoice ...

 

GetVoiceInterface()

Get the interface for accessing voice related data

Public function

bool

 

Init()

Initialize the underlying subsystem APIs

Public function

bool

 

IsDedicated()

Is the online subsystem associated with the game/editor/engine running as dedicated.

Public function

bool

 

IsEnabled()

True if the subsystem is enabled, false otherwise

Public function Static

bool

 

IsEnabled

(
    const FName & SubsystemName
)

Determine if the subsystem for a given interface is enabled by config and command line

Public function Static

bool

 

IsLoaded

(
    const FName & SubsystemName
)

Determine if the subsystem for a given interface is already loaded

Public function

bool

 

IsLocalPlayer

(
    const FUniqueNetId & UniqueId
)

Is a player local to this machine by unique id

Public function

bool

 

IsServer()

Is this instance of the game running as a server (dedicated OR listen) checks the Engine if possible for netmode status

Public function

void

 

PreUnload()

Perform any shutdown actions prior to any other modules being unloaded/shutdown

Public function

void

 

ReloadConfigs

(
    const TSet < FString >& ConfigSecti...
)

Reload the configuration if it is relevant for this OSS instance

Public function Static

void

 

ReloadDefaultSubsystem()

Unload the current default subsystem and attempt to reload the configured default subsystem May be different if the fallback subsystem was created an startup

Public function

void

 

SetForceDedicated

(
    bool bForce
)

Force the online subsystem to behave as if it's associated with running a dedicated server

Public function

void

 

SetNamedInterface

(
    FName InterfaceName,
    UObject * NewInterface
)

Set a custom UObject to be preserved by the online subsystem

Public function

void

 

SetUsingMultiplayerFeatures

(
    const FUniqueNetId & UniqueId,
    bool bUsingMP
)

Some platforms must know when the game is using Multiplayer features so they can do recurring authorization checks.

Public function

bool

 

Shutdown()

Shutdown the underlying subsystem APIs

Public function Virtual

void

 

TriggerOnConnectionStatusChangedDelegates

(
    const FString & Param1,
    EOnlineServerConnectionStatus::Type ...,
    EOnlineServerConnectionStatus::Type ...
)

Public function Virtual

void

 

TriggerOnOnlineEnvironmentChangedDelegates

(
    EOnlineEnvironment::Type Param1,
    EOnlineEnvironment::Type Param2
)

Public function Virtual

void

 

TriggerOnPlayTogetherEventReceivedDelegates

(
    int32 Param1,
    TArray < TSharedPtr < const FUniqueNe ...
)

References