1. Epic GamesDeveloper
  3. FOnlineSubsystemImpl

FOnlineSubsystemImpl

[FOnlineSubsystemImpl](API\Plugins\OnlineSubsystem\FOnlineSubsystemImpl) - common functionality to share across online platforms, not intended for direct use

API > API/Plugins > API/Plugins/OnlineSubsystem

FOnlineSubsystemImpl - common functionality to share across online platforms, not intended for direct use

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

Syntax

class FOnlineSubsystemImpl :  
    public IOnlineSubsystem ,  
    public FTSTickerObjectBase

Inheritance Hierarchy

Implements Interfaces

Derived Classes

FOnlineSubsystemImpl derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
Hidden on purpose OnlineSubsystemImpl.h  

FOnlineSubsystemImpl ( FName InSubsystemName,
FName InInstanceName
)

   OnlineSubsystemImpl.h  

FOnlineSubsystemImpl ( FName InSubsystemName,
FName InInstanceName,
FTSTicker& Ticker
)

   OnlineSubsystemImpl.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOnlineSubsystemImpl()

   OnlineSubsystemImpl.h  

Constants

Name Type Remarks Include Path
DefaultInstanceName const FName Name given to default OSS instances (disambiguates for PIE) OnlineSubsystemImpl.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ExecuteDelegateNextTick ( const FNextTickDelegate& Callback
)

 Queue a delegate to be executed on the next tick OnlineSubsystemImpl.h  

void ExecuteNextTick ( LAMBDA_TYPE&& Callback
)

 Templated helper for calling ExecuteDelegateNextTick with a lambda function OnlineSubsystemImpl.h  

virtual void OnConfigSectionsChanged ( const FString& IniFilename,
const TSet< FString >& SectionNames
)

 Delegate for config file changes. OnlineSubsystemImpl.h  

Overridden from IOnlineSubsystem

Name Remarks Include Path Unreal Specifiers

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

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

virtual IOnlineAchievementsPtr GetAchievementsInterface()

 Get the interface for accessing online achievements OnlineSubsystemImpl.h  

virtual IOnlineChatPtr GetChatInterface()

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

virtual IOnlineEntitlementsPtr GetEntitlementsInterface()

 Get the interface for accessing user entitlements OnlineSubsystemImpl.h  

virtual IOnlineEventsPtr GetEventsInterface()

 Get the interface for accessing online achievements OnlineSubsystemImpl.h  

virtual IOnlineExternalUIPtr GetExternalUIInterface()

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

virtual IOnlineGameActivityPtr GetGameActivityInterface()

 Get interface for accessing the game activity OnlineSubsystemImpl.h  

virtual IOnlineGameItemStatsPtr GetGameItemStatsInterface()

 Get interface for accessing the game item stats OnlineSubsystemImpl.h  

virtual IOnlineGameMatchesPtr GetGameMatchesInterface()

 Get interface for accessing game matches OnlineSubsystemImpl.h  

virtual IOnlineGroupsPtr GetGroupsInterface()

 IOnlineSubsystem. OnlineSubsystemImpl.h  

virtual IOnlineIdentityPtr GetIdentityInterface()

 Get the interface for accessing identity online services OnlineSubsystemImpl.h  

virtual FName GetInstanceName ()

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

virtual IOnlineLeaderboardsPtr GetLeaderboardsInterface()

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

virtual IOnlineMessagePtr GetMessageInterface()

 Get the interface for accessing online messages OnlineSubsystemImpl.h  

virtual IMessageSanitizerPtr GetMessageSanitizer ( int32 LocalUserNum,
FString& OutAuthTypeToExclude
) const

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

virtual UObject * GetNamedInterface ( FName InterfaceName
)

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

virtual IOnlineContentAgeRestrictionPtr GetOnlineContentAgeRestrictionInterface()

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

virtual EOnlineEnvironment::Type GetOnlineEnvironment()

   OnlineSubsystemImpl.h  

virtual FString GetOnlineEnvironmentName()

   OnlineSubsystemImpl.h  

virtual IOnlinePartyPtr GetPartyInterface()

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

virtual IOnlinePresencePtr GetPresenceInterface()

 Get the interface for managing rich presence information OnlineSubsystemImpl.h  

virtual IOnlinePurchasePtr GetPurchaseInterface()

 Get the interface for purchasing OnlineSubsystemImpl.h  

virtual IOnlineSharedCloudPtr GetSharedCloudInterface()

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

virtual IOnlineSharingPtr GetSharingInterface()

 Get the interface for accessing online sharing OnlineSubsystemImpl.h  

virtual FText GetSocialPlatformName()

   OnlineSubsystemImpl.h  

virtual IOnlineStatsPtr GetStatsInterface()

 Get the interface for accessing online stats OnlineSubsystemImpl.h  

virtual IOnlineStoreV2Ptr GetStoreV2Interface()

 Get the interface for accessing an online store OnlineSubsystemImpl.h  

virtual FName GetSubsystemName ()

 Return the name of the subsystem OnlineSubsystemImpl.h  

virtual IOnlineTimePtr GetTimeInterface()

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

virtual IOnlineTitleFilePtr GetTitleFileInterface()

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

virtual IOnlineTournamentPtr GetTournamentInterface()

 Get the interface for managing tournament information OnlineSubsystemImpl.h  

virtual IOnlineTurnBasedPtr GetTurnBasedInterface()

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

virtual IOnlineUserCloudPtr GetUserCloudInterface()

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

virtual IOnlineUserPtr GetUserInterface()

 Get the interface for accessing online user information OnlineSubsystemImpl.h  

virtual IOnlineVoicePtr GetVoiceInterface()

 Get the interface for accessing voice related data OnlineSubsystemImpl.h  

virtual bool IsDedicated ()

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

virtual bool IsEnabled()

   OnlineSubsystemImpl.h  

virtual bool IsLocalPlayer ( const FUniqueNetId& UniqueId
) const

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

virtual bool IsServer()

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

virtual void PreUnload()

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

virtual void ReloadConfigs ( const TSet< FString >& ConfigSections
)

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

virtual void SetForceDedicated ( bool bForce
)

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

virtual void SetNamedInterface ( FName InterfaceName,
UObject* NewInterface
)

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

virtual 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. OnlineSubsystemImpl.h  

virtual bool Shutdown()

 Shutdown the underlying subsystem APIs OnlineSubsystemImpl.h  

Overridden from FTSTickerObjectBase

Name Remarks Include Path Unreal Specifiers

virtual bool Tick ( float DeltaTime
)

 FTSTickerObjectBase. OnlineSubsystemImpl.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitNamedInterfaces()

 Load in any named interfaces specified by the ini configuration OnlineSubsystemImpl.h  

void OnNamedInterfaceCleanup()

 Delegate fired when named interfaces are cleaned up at exit OnlineSubsystemImpl.h  

void StartTicker()

 Start Ticker OnlineSubsystemImpl.h  

void StopTicker()

 Stop Ticker OnlineSubsystemImpl.h  

Static

Name Remarks Include Path Unreal Specifiers

static FString FilterResponseStr ( const FString& ResponseStr,
const TArray< FString >& RedactFields
)

 Modify a response string so that it can be logged cleanly OnlineSubsystemImpl.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page