Navigation
API > API/Plugins > API/Plugins/OnlineSubsystemSteam
OnlineSubsystemSteam - Implementation of the online subsystem for STEAM services
| Name | FOnlineSubsystemSteam |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystemSteam/Source/Public/OnlineSubsystemSteam.h |
| Include Path | #include "OnlineSubsystemSteam.h" |
Syntax
class FOnlineSubsystemSteam : public FOnlineSubsystemImpl
Inheritance Hierarchy
- FTSTickerObjectBase → FOnlineSubsystemImpl → FOnlineSubsystemSteam
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Only the factory makes instances | OnlineSubsystemSteam.h | ||
FOnlineSubsystemSteam
(
FName InInstanceName |
OnlineSubsystemSteam.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineSubsystemSteam() |
OnlineSubsystemSteam.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
DEFINE_ONLINE_DELEGATE_ONE_PARAM
(
OnSteamServerLoginCompleted, |
This delegate fires whenever a steam login has succeeded or failed its async task. | OnlineSubsystemSteam.h | |
virtual FOnlineAuthSteamPtr GetAuthInterface() |
OnlineSubsystemSteam.h | ||
virtual FOnlineAuthSteamUtilsPtr GetAuthInterfaceUtils() |
OnlineSubsystemSteam.h | ||
virtual FOnlineEncryptedAppTicketSteamPtr GetEncryptedAppTicketInterface() |
OnlineSubsystemSteam.h | ||
int32 GetGameServerGamePort() |
OnlineSubsystemSteam.h | ||
int32 GetGameServerQueryPort() |
OnlineSubsystemSteam.h | ||
virtual FOnlinePingSteamPtr GetPingInterface() |
OnlineSubsystemSteam.h | ||
uint32 GetSteamAppId() |
OnlineSubsystemSteam.h | ||
bool IsSteamClientAvailable() |
Whether or not the Steam Client interfaces are available; these interfaces are only available, if the Steam Client program is running NOTE: These interfaces are made unavailable, when running a dedicated server | OnlineSubsystemSteam.h | |
bool IsSteamServerAvailable() |
Whether or not the Steam game server interfaces are available; these interfaces are always available, so long as they were initialized correctly NOTE: The Steam Client does not need to be running for the game server interfaces to initialize NOTE: These interfaces are made unavailable, when not running a server | OnlineSubsystemSteam.h | |
bool IsUsingSteamNetworking() |
OnlineSubsystemSteam.h | ||
virtual void SetPingInterface
(
FOnlinePingSteamPtr InPingInterface |
OnlineSubsystemSteam.h |
Overridden from IOnlineSubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Exec
(
UWorld* InWorld, |
OnlineSubsystemSteam.h | ||
virtual IOnlineAchievementsPtr GetAchievementsInterface() |
OnlineSubsystemSteam.h | ||
virtual FString GetAppId() |
OnlineSubsystemSteam.h | ||
virtual IOnlineChatPtr GetChatInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineEntitlementsPtr GetEntitlementsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineEventsPtr GetEventsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineExternalUIPtr GetExternalUIInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineFriendsPtr GetFriendsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineGroupsPtr GetGroupsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineIdentityPtr GetIdentityInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineLeaderboardsPtr GetLeaderboardsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineMessagePtr GetMessageInterface() |
OnlineSubsystemSteam.h | ||
virtual FText GetOnlineServiceName() |
OnlineSubsystemSteam.h | ||
virtual IOnlinePartyPtr GetPartyInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlinePresencePtr GetPresenceInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlinePurchasePtr GetPurchaseInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineSessionPtr GetSessionInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineSharedCloudPtr GetSharedCloudInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineSharingPtr GetSharingInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineStatsPtr GetStatsInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineStoreV2Ptr GetStoreV2Interface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineTimePtr GetTimeInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineTitleFilePtr GetTitleFileInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineTournamentPtr GetTournamentInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineTurnBasedPtr GetTurnBasedInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineUserCloudPtr GetUserCloudInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineUserPtr GetUserInterface() |
OnlineSubsystemSteam.h | ||
virtual IOnlineVoicePtr GetVoiceInterface() |
OnlineSubsystemSteam.h | ||
virtual bool Init() |
OnlineSubsystemSteam.h | ||
virtual bool IsEnabled() |
OnlineSubsystemSteam.h | ||
virtual bool IsLocalPlayer
(
const FUniqueNetId& UniqueId |
OnlineSubsystemSteam.h | ||
virtual bool Shutdown() |
OnlineSubsystemSteam.h |
Overridden from FTSTickerObjectBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool Tick
(
float DeltaTime |
OnlineSubsystemSteam.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearUserCloudFiles() |
Clear out all the data related to user cloud storage | OnlineSubsystemSteam.h | |
bool ClearUserCloudMetadata
(
const FUniqueNetId& UserId, |
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 | OnlineSubsystemSteam.h | |
FOnlineLeaderboardsSteam * GetInternalLeaderboardsInterface() |
INTERNAL Get the interface for accessing leaderboards/stats | OnlineSubsystemSteam.h | |
FSteamUserCloudData * GetUserCloudEntry
(
const FUniqueNetId& UserId |
INTERNAL Get the metadata related to a given user This information is only available after calling EnumerateUserFiles | OnlineSubsystemSteam.h | |
bool InitSteamworksClient
(
bool bRelaunchInSteam, |
Initialize the client side APIs for Steam | OnlineSubsystemSteam.h | |
bool InitSteamworksServer() |
Initialize the server side APIs for Steam | OnlineSubsystemSteam.h | |
void QueueAsyncOutgoingItem
(
FOnlineAsyncItem* AsyncItem |
Add an async task onto the outgoing task queue for processing | OnlineSubsystemSteam.h | |
void QueueAsyncTask
(
FOnlineAsyncTask* AsyncTask |
Add an async task onto the task queue for processing | OnlineSubsystemSteam.h | |
void ShutdownSteamworks() |
Shutdown the Steam APIs | OnlineSubsystemSteam.h |