Choose your operating system:
Windows
macOS
Linux
| IOnlineSubsystem | ||||
| FTSTickerObjectBase
|
|
Module |
|
|
Header |
/Engine/Plugins/Online/OnlineSubsystemSteam/Source/Public/OnlineSubsystemSteam.h |
|
Include |
#include "OnlineSubsystemSteam.h" |
class FOnlineSubsystemSteam : public FOnlineSubsystemImpl
OnlineSubsystemSteam - Implementation of the online subsystem for STEAM services
| Name | Description | ||
|---|---|---|---|
|
|
AchievementsInterface |
Interface for achievements |
|
|
|
AuthInterface |
Interface for Steam Session Auth |
|
|
|
AuthInterfaceUtils |
||
|
|
bSteamworksClientInitialized |
Has the STEAM client APIs been initialized |
|
|
|
bSteamworksGameServerInitialized |
Whether or not the Steam game server API is initialized |
|
|
|
bUsingSteamNetworking |
If we are using the SteamNetworking protocol or not. |
|
|
|
bVoiceInterfaceInitialized |
Interface for voice communication |
|
|
|
EncryptedAppTicketInterface |
Interface for Steam encrypted application tickets. |
|
|
|
FOnlineExternal... |
ExternalUIInterface |
Interface to the external UI services |
|
|
FOnlineFriendsS... |
FriendInterface |
Interface to the friend services |
|
|
GameServerGamePort |
Game port - the port that clients will connect to for gameplay |
|
|
|
GameServerQueryPort |
Query port - the port that will manage server browser related duties and info |
|
|
|
FOnlineIdentity... |
IdentityInterface |
Interface to the profile services |
|
|
FOnlineLeaderbo... |
LeaderboardsInterface |
Interface to the leaderboard services |
|
|
OnlineAsyncTaskThread |
Online async task thread |
|
|
|
FOnlineAsyncTas... |
OnlineAsyncTaskThreadRunnable |
Online async task runnable |
|
|
OnSteamServerLoginCompletedDelegates |
This delegate fires whenever a steam login has succeeded or failed its async task. |
|
|
|
PingInterface |
Interface for dynamically calculating SteamNetworking ping based off protocol |
|
|
|
FOnlinePresence... |
PresenceInterface |
Interface for presence |
|
|
FOnlineSessionS... |
SessionInterface |
Interface to the session services |
|
|
FOnlineSharedCl... |
SharedCloudInterface |
Interface to the shared cloud services |
|
|
TSharedPtr< cla... |
SteamAPIClientHandle |
Steam Client API Handle |
|
|
TSharedPtr< cla... |
SteamAPIServerHandle |
Steam Server API Handle |
|
|
SteamAppID |
Steam App ID for the running game |
|
|
|
TArray< struct ... |
UserCloudData |
Array of the files in the cloud for a given user |
|
|
UserCloudDataLock |
Critical sections for thread safe operation of the cloud files |
|
|
|
FOnlineUserClou... |
UserCloudInterface |
Interface to the user cloud services |
|
|
VoiceInterface |
Interface to the voice engine |
| Name | Description | |
|---|---|---|
|
|
FOnlineSubsystemSteam() |
Only the factory makes instances |
|
|
FOnlineSubsystemSteam ( |
| Name | Description | |
|---|---|---|
|
|
~FOnlineSubsystemSteam() |
| Name | Description | ||
|---|---|---|---|
|
|
FDelegateHan... |
AddOnSteamServerLoginCompletedDelegate_Handle ( |
|
|
|
ClearOnSteamServerLoginCompletedDelegate_Handle ( |
||
|
|
ClearOnSteamServerLoginCompletedDelegates ( |
||
|
|
ClearUserCloudFiles() |
Clear out all the data related to user cloud storage |
|
|
|
ClearUserCloudMetadata ( |
INTERNAL** Clear the metadata related to a given user's file on Steam This information is only available after calling EnumerateUserFiles It doesn't actually delete any of the actual data on disk |
|
|
|
FOnlineAuthS... |
GetAuthInterface() |
|
|
|
FOnlineAuthS... |
GetAuthInterfaceUtils() |
|
|
|
FOnlineEncry... |
GetEncryptedAppTicketInterface() |
|
|
|
GetGameServerGamePort() |
||
|
|
GetGameServerQueryPort() |
||
|
|
FOnlineLeade... |
GetInternalLeaderboardsInterface() |
INTERNAL** Get the interface for accessing leaderboards/stats |
|
|
FOnlinePingS... |
GetPingInterface() |
|
|
|
GetSteamAppId() |
||
|
|
FSteamUserCl... |
GetUserCloudEntry ( |
INTERNAL** Get the metadata related to a given user This information is only available after calling EnumerateUserFiles |
|
|
InitSteamworksClient |
Initialize the client side APIs for Steam |
|
|
|
InitSteamworksServer() |
Initialize the server side APIs for Steam |
|
|
|
IsSteamClientAvailable() |
Whether or not the Steam Client interfaces are available; these interfaces are only available, if the Steam Client program is running |
|
|
|
IsSteamServerAvailable() |
Whether or not the Steam game server interfaces are available; these interfaces are always available, so long as they were initialized correctly |
|
|
|
IsUsingSteamNetworking() |
||
|
|
QueueAsyncOutgoingItem ( |
Add an async task onto the outgoing task queue for processing |
|
|
|
QueueAsyncTask ( |
Add an async task onto the task queue for processing |
|
|
|
SetPingInterface ( |
||
|
|
ShutdownSteamworks() |
Shutdown the Steam APIs |
|
|
|
TriggerOnSteamServerLoginCompletedDelegates ( |
| Name | Description | ||
|---|---|---|---|
|
|
Exec ( |
Exec handler that allows the online subsystem to process exec commands |
|
|
|
IOnlineAchie... |
GetAchievementsInterface() |
Get the interface for accessing online achievements |
|
|
GetAppId() |
Each online subsystem has a global id for the app |
|
|
|
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 |
|
|
IOnlineGroup... |
GetGroupsInterface() |
|
|
|
IOnlineIdent... |
GetIdentityInterface() |
Get the interface for accessing identity online services |
|
|
IOnlineLeade... |
GetLeaderboardsInterface() |
Get the interface for accessing leaderboards/rankings of a service |
|
|
IOnlineMessa... |
GetMessageInterface() |
Get the interface for accessing online messages |
|
|
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 |
|
|
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 |
|
|
|
IsEnabled() |
||
|
|
IsLocalPlayer ( |
Is a player local to this machine by unique id |
|
|
|
Shutdown() |
Shutdown the underlying subsystem APIs |
| Name | Description | ||
|---|---|---|---|
|
|
Tick ( |