1. Epic GamesDeveloper
  3. IOnlineSubsystem

IOnlineSubsystem

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

API > API/Plugins > API/Plugins/OnlineSubsystem

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

   
Name IOnlineSubsystem
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystem.h
Include Path #include "OnlineSubsystem.h"

Syntax

class IOnlineSubsystem

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

IOnlineSubsystem()

 Hidden on purpose OnlineSubsystem.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineSubsystem()

   OnlineSubsystem.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnConfigChangedDelegates FOnConfigChanged Delegate fired when a configuration change was detected as a result of ReloadConfigs being called. OnlineSubsystem.h  
OnConnectionStatusChangedDelegates FOnConnectionStatusChanged Called when the connection state as reported by the online platform changes OnlineSubsystem.h  
OnOnlineEnvironmentChangedDelegates FOnOnlineEnvironmentChanged Delegate fired when the online environment changes OnlineSubsystem.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnConfigChangedDelegate_Handle ( const FOnConfigChangedDelegate& Delegate
)

   OnlineSubsystem.h  

virtual FDelegateHandle AddOnConnectionStatusChangedDelegate_Handle ( const FOnConnectionStatusChangedDelegate& Delegate
)

   OnlineSubsystem.h  

virtual FDelegateHandle AddOnOnlineEnvironmentChangedDelegate_Handle ( const FOnOnlineEnvironmentChangedDelegate& Delegate
)

   OnlineSubsystem.h  

virtual void ClearOnConfigChangedDelegate_Handle ( FDelegateHandle& Handle
)

   OnlineSubsystem.h  

virtual void ClearOnConfigChangedDelegates ( FDelegateUserObject Object
)

   OnlineSubsystem.h  

virtual void ClearOnConnectionStatusChangedDelegate_Handle ( FDelegateHandle& Handle
)

   OnlineSubsystem.h  

virtual void ClearOnConnectionStatusChangedDelegates ( FDelegateUserObject Object
)

   OnlineSubsystem.h  

virtual void ClearOnOnlineEnvironmentChangedDelegate_Handle ( FDelegateHandle& Handle
)

   OnlineSubsystem.h  

virtual void ClearOnOnlineEnvironmentChangedDelegates ( FDelegateUserObject Object
)

   OnlineSubsystem.h  

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

 Exec handler that allows the online subsystem to process exec commands OnlineSubsystem.h  

IOnlineAchievementsPtr GetAchievementsInterface()

 Get the interface for accessing online achievements OnlineSubsystem.h  

FString GetAppId()

 Each online subsystem has a global id for the app OnlineSubsystem.h  

IOnlineChatPtr GetChatInterface()

 Get the interface for user-user and user-room chat functionality OnlineSubsystem.h  

IOnlineEntitlementsPtr GetEntitlementsInterface()

 Get the interface for accessing user entitlements OnlineSubsystem.h  

IOnlineEventsPtr GetEventsInterface()

 Get the interface for accessing online achievements OnlineSubsystem.h  

IOnlineExternalUIPtr GetExternalUIInterface()

 Get the interface for accessing the external UIs of a service OnlineSubsystem.h  

IOnlineFriendsPtr GetFriendsInterface()

 Get the interface for accessing the player friends services OnlineSubsystem.h  

IOnlineGameActivityPtr GetGameActivityInterface()

 Get interface for accessing the game activity OnlineSubsystem.h  

IOnlineGameItemStatsPtr GetGameItemStatsInterface()

 Get interface for accessing the game item stats OnlineSubsystem.h  

IOnlineGameMatchesPtr GetGameMatchesInterface()

 Get interface for accessing game matches OnlineSubsystem.h  

IOnlineGroupsPtr GetGroupsInterface()

 Get the interface for accessing the groups services OnlineSubsystem.h  

IOnlineIdentityPtr GetIdentityInterface()

 Get the interface for accessing identity online services OnlineSubsystem.h  
Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode. OnlineSubsystem.h  

IOnlineLeaderboardsPtr GetLeaderboardsInterface()

 Get the interface for accessing leaderboards/rankings of a service OnlineSubsystem.h  

IOnlineMessagePtr GetMessageInterface()

 Get the interface for accessing online messages OnlineSubsystem.h  

IMessageSanitizerPtr GetMessageSanitizer ( int32 LocalUserNum,
FString& OutAuthTypeToExclude
) const

 Get the interface for accessing the message sanitizer service OnlineSubsystem.h  

UObject * GetNamedInterface ( FName InterfaceName
)

 Get custom UObject data preserved by the online subsystem OnlineSubsystem.h  

IOnlineContentAgeRestrictionPtr GetOnlineContentAgeRestrictionInterface()

 Get interface for accessing the online content age restriction OnlineSubsystem.h  

EOnlineEnvironment::Type GetOnlineEnvironment()

   OnlineSubsystem.h  

FString GetOnlineEnvironmentName()

   OnlineSubsystem.h  

FOnlineNotificationHandlerPtr GetOnlineNotificationHandler()

 Get the notification handler instance for this subsystem OnlineSubsystem.h  

FOnlineNotificationTransportManagerPtr GetOnlineNotificationTransportManager()

 Get the transport manager instance for this subsystem OnlineSubsystem.h  

FText GetOnlineServiceName()

   OnlineSubsystem.h  

IOnlinePartyPtr GetPartyInterface()

 Get the interface for accessing the player party services OnlineSubsystem.h  

IOnlinePresencePtr GetPresenceInterface()

 Get the interface for managing rich presence information OnlineSubsystem.h  

IOnlinePurchasePtr GetPurchaseInterface()

 Get the interface for purchasing OnlineSubsystem.h  

IOnlineSessionPtr GetSessionInterface()

 Get the interface for accessing the session management services OnlineSubsystem.h  

IOnlineSharedCloudPtr GetSharedCloudInterface()

 Get the interface for sharing user files in the cloud OnlineSubsystem.h  

IOnlineSharingPtr GetSharingInterface()

 Get the interface for accessing online sharing OnlineSubsystem.h  

FText GetSocialPlatformName()

   OnlineSubsystem.h  

IOnlineStatsPtr GetStatsInterface()

 Get the interface for accessing online stats OnlineSubsystem.h  

IOnlineStoreV2Ptr GetStoreV2Interface()

 Get the interface for accessing an online store OnlineSubsystem.h  
Return the name of the subsystem OnlineSubsystem.h  

IOnlineTimePtr GetTimeInterface()

 Get the interface for accessing the server time from an online service OnlineSubsystem.h  

IOnlineTitleFilePtr GetTitleFileInterface()

 Get the interface for accessing title file online services OnlineSubsystem.h  

IOnlineTournamentPtr GetTournamentInterface()

 Get the interface for managing tournament information OnlineSubsystem.h  

IOnlineTurnBasedPtr GetTurnBasedInterface()

 Get the interface for managing turn based multiplayer games OnlineSubsystem.h  

IOnlineUserCloudPtr GetUserCloudInterface()

 Get the interface for accessing user files in the cloud OnlineSubsystem.h  

IOnlineUserPtr GetUserInterface()

 Get the interface for accessing online user information OnlineSubsystem.h  

IOnlineVoicePtr GetVoiceInterface()

 Get the interface for accessing voice related data OnlineSubsystem.h  

bool Init()

 Initialize the underlying subsystem APIs OnlineSubsystem.h  

bool IsDedicated ()

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

bool IsEnabled ()

   OnlineSubsystem.h  

bool IsLocalPlayer ( const FUniqueNetId& UniqueId
) const

 Is a player local to this machine by unique id OnlineSubsystem.h  

bool IsServer()

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

void PreUnload()

 Perform any shutdown actions prior to any other modules being unloaded/shutdown OnlineSubsystem.h  

void ReloadConfigs ( const TSet< FString >& ConfigSections
)

 Reload the configuration if it is relevant for this OSS instance OnlineSubsystem.h  

void SetForceDedicated ( bool bForce
)

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

void SetNamedInterface ( FName InterfaceName,
UObject* NewInterface
)

 Set a custom UObject to be preserved by the online subsystem OnlineSubsystem.h  

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. OnlineSubsystem.h  

bool Shutdown()

 Shutdown the underlying subsystem APIs OnlineSubsystem.h  

virtual void TriggerOnConfigChangedDelegates ( const TSet< FString >& Param1
)

   OnlineSubsystem.h  

virtual void TriggerOnConnectionStatusChangedDelegates ( const FString& Param1,
EOnlineServerConnectionStatus::Type Param2,
EOnlineServerConnectionStatus::Type Param3
)

   OnlineSubsystem.h  

virtual void TriggerOnOnlineEnvironmentChangedDelegates ( EOnlineEnvironment::Type Param1,
EOnlineEnvironment::Type Param2
)

   OnlineSubsystem.h  

Protected

Static

Name Remarks Include Path Unreal Specifiers

static void Destroy ( FName SubsystemName
)

 Destroy a single online subsystem instance OnlineSubsystem.h  

static bool DoesInstanceExist ( const FName& SubsystemName
)

 Determine if an instance of the subsystem already exists OnlineSubsystem.h  

static IOnlineSubsystem * Get ( const FName& SubsystemName
)

 Get the online subsystem for a given service OnlineSubsystem.h  

static IOnlineSubsystem * GetByConfig ( const FString& ConfigString,
bool bAutoLoad
)

 Get the online subsystem associated with the given config string OnlineSubsystem.h  

static IOnlineSubsystem * GetByPlatform ( bool bAutoLoad
)

 Get the online subsystem native to the current hardware OnlineSubsystem.h  
Get the local online platform based on compile time determination of hardware. OnlineSubsystem.h  

static bool IsEnabled ( const FName& SubsystemName,
const FName& InstanceName
)

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

static bool IsLoaded ( const FName& SubsystemName
)

 Determine if the subsystem for a given interface is already loaded OnlineSubsystem.h  

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 OnlineSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page