IOnlineSubsystem


Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystem.h
Include	#include "OnlineSubsystem.h"

Type	Name	Description
FOnConfigChanged	OnConfigChangedDelegates	Delegate fired when a configuration change was detected as a result of ReloadConfigs being called.
FOnConnectionStatusChanged	OnConnectionStatusChangedDelegates	Called when the connection state as reported by the online platform changes
FOnlineNotificationHandlerPtr	OnlineNotificationHandler
FOnlineNotificationTransportManagerPtr	OnlineNotificationTransportManager
FOnOnlineEnvironmentChanged	OnOnlineEnvironmentChangedDelegates	Delegate fired when the online environment changes

	Type	Name	Description
		IOnlineSubsystem ()	Hidden on purpose

	Type	Name	Description
		~IOnlineSubsystem ()

Type	Name	Description
FDelegateHandle	AddOnConfigChangedDelegate_Handle ( const FOnConfigChangedDelegate& Delegate )
FDelegateHandle	AddOnConnectionStatusChangedDelegate_Handle ( const FOnConnectionStatusChangedDelegate& Delegate )
FDelegateHandle	AddOnOnlineEnvironmentChangedDelegate_Handle ( const FOnOnlineEnvironmentChangedDelegate& Delegate )
void	ClearOnConfigChangedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnConfigChangedDelegates ( void* Object )
void	ClearOnConnectionStatusChangedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnConnectionStatusChangedDelegates ( void* Object )
void	ClearOnOnlineEnvironmentChangedDelegate_Handle ( FDelegateHandle& Handle )
void	ClearOnOnlineEnvironmentChangedDelegates ( void* Object )
void	Destroy ( FName SubsystemName )	Destroy a single online subsystem instance
bool	DoesInstanceExist ( const FName& SubsystemName )	Determine if an instance of the subsystem already exists
bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler that allows the online subsystem to process exec commands
IOnlineSubsystem *	Get ( const FName& SubsystemName )	Get the online subsystem for a given service
IOnlineAchievementsPtr	GetAchievementsInterface ()	Get the interface for accessing online achievements
FString	GetAppId ()	Each online subsystem has a global id for the app
IOnlineSubsystem *	GetByConfig ( const FString& ConfigString, bool bAutoLoad )	Get the online subsystem associated with the given config string
IOnlineSubsystem *	GetByPlatform ( bool bAutoLoad )	Get the online subsystem native to the current hardware
IOnlineChatPtr	GetChatInterface ()	Get the interface for user-user and user-room chat functionality
IOnlineEntitlementsPtr	GetEntitlementsInterface ()	Get the interface for accessing user entitlements
IOnlineEventsPtr	GetEventsInterface ()	Get the interface for accessing online achievements
IOnlineExternalUIPtr	GetExternalUIInterface ()	Get the interface for accessing the external UIs of a service
IOnlineFriendsPtr	GetFriendsInterface ()	Get the interface for accessing the player friends services
IOnlineGameActivityPtr	GetGameActivityInterface ()	Get interface for accessing the game activity
IOnlineGameItemStatsPtr	GetGameItemStatsInterface ()	Get interface for accessing the game item stats
IOnlineGameMatchesPtr	GetGameMatchesInterface ()	Get interface for accessing game matches
IOnlineGroupsPtr	GetGroupsInterface ()	Get the interface for accessing the groups services
IOnlineIdentityPtr	GetIdentityInterface ()	Get the interface for accessing identity online services
FName	GetInstanceName ()	Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode.
IOnlineLeaderboardsPtr	GetLeaderboardsInterface ()	Get the interface for accessing leaderboards/rankings of a service
FString	GetLocalPlatformName ()	Get the local online platform based on compile time determination of hardware.
IOnlineMessagePtr	GetMessageInterface ()	Get the interface for accessing online messages
IMessageSanitizerPtr	GetMessageSanitizer ( int32 LocalUserNum, FString& OutAuthTypeToExclude )	Get the interface for accessing the message sanitizer service
UObject *	GetNamedInterface ( FName InterfaceName )	Get custom UObject data preserved by the online subsystem
EOnlineEnvironment::Type	GetOnlineEnvironment ()
FString	GetOnlineEnvironmentName ()
FOnlineNotificationHandlerPtr	GetOnlineNotificationHandler ()	Get the notification handler instance for this subsystem
FOnlineNotificationTransportManagerPtr	GetOnlineNotificationTransportManager ()	Get the transport manager instance for this subsystem
FText	GetOnlineServiceName ()
IOnlinePartyPtr	GetPartyInterface ()	Get the interface for accessing the player party services
IOnlinePresencePtr	GetPresenceInterface ()	Get the interface for managing rich presence information
IOnlinePurchasePtr	GetPurchaseInterface ()	Get the interface for purchasing
IOnlineSessionPtr	GetSessionInterface ()	Get the interface for accessing the session management services
IOnlineSharedCloudPtr	GetSharedCloudInterface ()	Get the interface for sharing user files in the cloud
IOnlineSharingPtr	GetSharingInterface ()	Get the interface for accessing online sharing
FText	GetSocialPlatformName ()
IOnlineStatsPtr	GetStatsInterface ()	Get the interface for accessing online stats
IOnlineStoreV2Ptr	GetStoreV2Interface ()	Get the interface for accessing an online store
FName	GetSubsystemName ()	Return the name of the subsystem
IOnlineTimePtr	GetTimeInterface ()	Get the interface for accessing the server time from an online service
IOnlineTitleFilePtr	GetTitleFileInterface ()	Get the interface for accessing title file online services
IOnlineTournamentPtr	GetTournamentInterface ()	Get the interface for managing tournament information
IOnlineTurnBasedPtr	GetTurnBasedInterface ()	Get the interface for managing turn based multiplayer games
IOnlineUserCloudPtr	GetUserCloudInterface ()	Get the interface for accessing user files in the cloud
IOnlineUserPtr	GetUserInterface ()	Get the interface for accessing online user information
IOnlineVoicePtr	GetVoiceInterface ()	Get the interface for accessing voice related data
bool	Init ()	Initialize the underlying subsystem APIs
bool	IsDedicated ()	Is the online subsystem associated with the game/editor/engine running as dedicated.
bool	IsEnabled ()
bool	IsEnabled ( const FName& SubsystemName, const FName& InstanceName )	Determine if the subsystem for a given interface is enabled by config and command line
bool	IsLoaded ( const FName& SubsystemName )	Determine if the subsystem for a given interface is already loaded
bool	IsLocalPlayer ( const FUniqueNetId& UniqueId )	Is a player local to this machine by unique id
bool	IsServer ()	Is this instance of the game running as a server (dedicated OR listen) checks the Engine if possible for netmode status
void	PreUnload ()	Perform any shutdown actions prior to any other modules being unloaded/shutdown
void	ReloadConfigs ( const TSet< FString >& ConfigSections )	Reload the configuration if it is relevant for this OSS instance
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
void	SetForceDedicated ( bool bForce )	Force the online subsystem to behave as if it's associated with running a dedicated server
void	SetNamedInterface ( FName InterfaceName, UObject* NewInterface )	Set a custom UObject to be preserved by the online subsystem
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.
bool	Shutdown ()	Shutdown the underlying subsystem APIs
void	TriggerOnConfigChangedDelegates ( const TSet< FString >& Param1 )
void	TriggerOnConnectionStatusChangedDelegates ( const FString& Param1, EOnlineServerConnectionStatus::Type Param2, EOnlineServerConnectionStatus::Type Param3 )
void	TriggerOnOnlineEnvironmentChangedDelegates ( EOnlineEnvironment::Type Param1, EOnlineEnvironment::Type Param2 )

Navigation

Inheritance Hierarchy

References

Syntax

Remarks

Variables

Constructors

Destructors

Functions