Module |
|
Header |
/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystem.h |
Include |
#include "OnlineSubsystem.h" |
class IOnlineSubsystem
OnlineSubsystem - Series of interfaces to support communicating with various web/platform layer services
Name | Description | ||
---|---|---|---|
|
OnConnectionStatusChangedDelegates |
Called when the connection state as reported by the online platform changes |
|
|
OnlineNotificationHandler |
||
|
OnlineNotificationTransportManager |
||
|
OnOnlineEnvironmentChangedDelegates |
Delegate fired when the online environment changes |
|
|
OnPlayTogetherEventReceivedDelegates |
Delegate fired when the "Play Together" event is sent from the PS4 system |
Name | Description | |
---|---|---|
|
IOnlineSubsystem() |
Hidden on purpose |
Name | Description | |
---|---|---|
|
~IOnlineSubsystem() |
Name | Description | ||
---|---|---|---|
|
FDelegateHan... |
AddOnConnectionStatusChangedDelegate_Handle ( |
|
|
FDelegateHan... |
AddOnOnlineEnvironmentChangedDelegate_Handle ( |
|
|
FDelegateHan... |
AddOnPlayTogetherEventReceivedDelegate_Handle ( |
|
|
ClearOnConnectionStatusChangedDelegate_Handle ( |
||
|
ClearOnConnectionStatusChangedDelegates ( |
||
|
ClearOnOnlineEnvironmentChangedDelegate_Handle ( |
||
|
ClearOnOnlineEnvironmentChangedDelegates ( |
||
|
ClearOnPlayTogetherEventReceivedDelegate_Handle ( |
||
|
ClearOnPlayTogetherEventReceivedDelegates ( |
||
|
Destroy ( |
Destroy a single online subsystem instance |
|
|
DoesInstanceExist ( |
Determine if an instance of the subsystem already exists |
|
|
Exec ( |
Exec handler that allows the online subsystem to process exec commands |
|
|
IOnlineSubsy... |
Get ( |
Get the online subsystem for a given service |
|
IOnlineAchie... |
GetAchievementsInterface() |
Get the interface for accessing online achievements |
|
GetAppId() |
Each online subsystem has a global id for the app |
|
|
IOnlineSubsy... |
GetByConfig |
Get the online subsystem associated with the given config string |
|
IOnlineSubsy... |
GetByPlatform ( |
Get the online subsystem native to the current hardware |
|
IOnlineChatP... |
GetChatInterface() |
Get the interface for user-user and user-room chat functionality |
|
IOnlineEntit... |
GetEntitlementsInterface() |
Get the interface for accessing user entitlements |
|
IOnlineEvent... |
GetEventsInterface() |
Get the interface for accessing online achievements |
|
IOnlineExter... |
GetExternalUIInterface() |
Get the interface for accessing the external UIs of a service |
|
IOnlineFrien... |
GetFriendsInterface() |
Get the interface for accessing the player friends services |
|
IOnlineGameA... |
GetGameActivityInterface() |
Get interface for accessing the game activity |
|
IOnlineGameI... |
GetGameItemStatsInterface() |
Get interface for accessing the game item stats |
|
IOnlineGroup... |
GetGroupsInterface() |
Get the interface for accessing the groups services |
|
IOnlineIdent... |
GetIdentityInterface() |
Get the interface for accessing identity online services |
|
GetInstanceName() |
Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode. |
|
|
IOnlineLeade... |
GetLeaderboardsInterface() |
Get the interface for accessing leaderboards/rankings of a service |
|
GetLocalPlatformName() |
Get the local online platform based on compile time determination of hardware. |
|
|
IOnlineMessa... |
GetMessageInterface() |
Get the interface for accessing online messages |
|
IMessageSani... |
GetMessageSanitizer |
Get the interface for accessing the message sanitizer service |
|
UObject *... |
GetNamedInterface ( |
Get custom UObject data preserved by the online subsystem |
|
EOnlineEnvir... |
GetOnlineEnvironment() |
|
|
GetOnlineEnvironmentName() |
||
|
FOnlineNotif... |
GetOnlineNotificationHandler() |
Get the notification handler instance for this subsystem |
|
FOnlineNotif... |
GetOnlineNotificationTransportManager() |
Get the transport manager instance for this subsystem |
|
GetOnlineServiceName() |
||
|
IOnlineParty... |
GetPartyInterface() |
Get the interface for accessing the player party services |
|
IOnlinePrese... |
GetPresenceInterface() |
Get the interface for managing rich presence information |
|
IOnlinePurch... |
GetPurchaseInterface() |
Get the interface for purchasing |
|
IOnlineSessi... |
GetSessionInterface() |
Get the interface for accessing the session management services |
|
IOnlineShare... |
GetSharedCloudInterface() |
Get the interface for sharing user files in the cloud |
|
IOnlineShari... |
GetSharingInterface() |
Get the interface for accessing online sharing |
|
IOnlineStats... |
GetStatsInterface() |
Get the interface for accessing online stats |
|
IOnlineStore... |
GetStoreV2Interface() |
Get the interface for accessing an online store |
|
GetSubsystemName() |
Return the name of the subsystem |
|
|
IOnlineTimeP... |
GetTimeInterface() |
Get the interface for accessing the server time from an online service |
|
IOnlineTitle... |
GetTitleFileInterface() |
Get the interface for accessing title file online services |
|
IOnlineTourn... |
GetTournamentInterface() |
Get the interface for managing tournament information |
|
IOnlineTurnB... |
GetTurnBasedInterface() |
Get the interface for managing turn based multiplayer games |
|
IOnlineUserC... |
GetUserCloudInterface() |
Get the interface for accessing user files in the cloud |
|
IOnlineUserP... |
GetUserInterface() |
Get the interface for accessing online user information |
|
IOnlineVoice... |
GetVoiceInterface() |
Get the interface for accessing voice related data |
|
Init() |
Initialize the underlying subsystem APIs |
|
|
IsDedicated() |
Is the online subsystem associated with the game/editor/engine running as dedicated. |
|
|
IsEnabled() |
||
|
IsEnabled |
Determine if the subsystem for a given interface is enabled by config and command line |
|
|
IsLoaded ( |
Determine if the subsystem for a given interface is already loaded |
|
|
IsLocalPlayer ( |
Is a player local to this machine by unique id |
|
|
IsServer() |
Is this instance of the game running as a server (dedicated OR listen) checks the Engine if possible for netmode status |
|
|
PreUnload() |
Perform any shutdown actions prior to any other modules being unloaded/shutdown |
|
|
ReloadConfigs |
Reload the configuration if it is relevant for this OSS instance |
|
|
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 |
|
|
SetForceDedicated ( |
Force the online subsystem to behave as if it's associated with running a dedicated server |
|
|
SetNamedInterface |
Set a custom UObject to be preserved by the online subsystem |
|
|
SetUsingMultiplayerFeatures ( |
Some platforms must know when the game is using Multiplayer features so they can do recurring authorization checks. |
|
|
Shutdown() |
Shutdown the underlying subsystem APIs |
|
|
TriggerOnConnectionStatusChangedDelegates ( |
||
|
TriggerOnOnlineEnvironmentChangedDelegates ( |
||
|
TriggerOnPlayTogetherEventReceivedDelegates ( |
Name | Description | ||
---|---|---|---|
|
IOnlineStore... |
GetStoreInterface() |
Move to OnlineStoreInterfaceV2 and OnlinePurchaseInterface. |