1. Epic GamesDeveloper
  3. FOnlineSubsystemSteam

FOnlineSubsystemSteam

OnlineSubsystemSteam - Implementation of the online subsystem for STEAM services

API > API/Plugins > API/Plugins/OnlineSubsystemSteam

Inheritance Hierarchy

References

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

Syntax

class FOnlineSubsystemSteam : public FOnlineSubsystemImpl

Remarks

OnlineSubsystemSteam - Implementation of the online subsystem for STEAM services

Variables

  Type Name Description
Protected variable FOnlineAchievementsSteamPtr AchievementsInterface Interface for achievements
Protected variable FOnlineAuthSteamPtr AuthInterface Interface for Steam Session Auth
Protected variable FOnlineAuthSteamUtilsPtr AuthInterfaceUtils  
Protected variable bool bSteamworksClientInitialized Has the STEAM client APIs been initialized
Protected variable bool bSteamworksGameServerInitialized Whether or not the Steam game server API is initialized
Protected variable bool bUsingSteamNetworking If we are using the SteamNetworking protocol or not.
Protected variable bool bVoiceInterfaceInitialized Interface for voice communication
Protected variable FOnlineEncryptedAppTicketSteamPtr EncryptedAppTicketInterface Interface for Steam encrypted application tickets.
Protected variable FOnlineExternalUISteamPtr ExternalUIInterface Interface to the external UI services
Protected variable FOnlineFriendsSteamPtr FriendInterface Interface to the friend services
Protected variable int32 GameServerGamePort Game port - the port that clients will connect to for gameplay
Protected variable int32 GameServerQueryPort Query port - the port that will manage server browser related duties and info
Protected variable FOnlineIdentitySteamPtr IdentityInterface Interface to the profile services
Protected variable FOnlineLeaderboardsSteamPtr LeaderboardsInterface Interface to the leaderboard services
Protected variable FRunnableThread * OnlineAsyncTaskThread Online async task thread
Protected variable FOnlineAsyncTaskManagerSteam * OnlineAsyncTaskThreadRunnable Online async task runnable
Public variable FOnSteamServerLoginCompleted OnSteamServerLoginCompletedDelegates This delegate fires whenever a steam login has succeeded or failed its async task.
Protected variable FOnlinePingSteamPtr PingInterface Interface for dynamically calculating SteamNetworking ping based off protocol
Protected variable FOnlinePresenceSteamPtr PresenceInterface Interface for presence
Protected variable FOnlineSessionSteamPtr SessionInterface Interface to the session services
Protected variable FOnlineSharedCloudSteamPtr SharedCloudInterface Interface to the shared cloud services
Protected variable TSharedPtr< class FSteamClientInstanceHandler > SteamAPIClientHandle Steam Client API Handle
Protected variable TSharedPtr< class FSteamServerInstanceHandler > SteamAPIServerHandle Steam Server API Handle
Protected variable uint32 SteamAppID Steam App ID for the running game
Protected variable TArray< struct FSteamUserCloudData * > UserCloudData Array of the files in the cloud for a given user
Protected variable FCriticalSection UserCloudDataLock Critical sections for thread safe operation of the cloud files
Protected variable FOnlineUserCloudSteamPtr UserCloudInterface Interface to the user cloud services
Protected variable IOnlineVoicePtr VoiceInterface Interface to the voice engine

Constructors

  Type Name Description
Protected function   Only the factory makes instances
Protected function  

FOnlineSubsystemSteam ( FName InInstanceName
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual void  
Public function Virtual void  
Protected function void Clear out all the data related to user cloud storage
Protected function bool

ClearUserCloudMetadata ( const FUniqueNetId& UserId,
const FString& Filename
)

 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
Public function Virtual Const FOnlineAuthSteamPtr  
Public function Virtual Const FOnlineAuthSteamUtilsPtr  
Public function Virtual Const FOnlineEncryptedAppTicketSteamPtr  
Public function Const int32  
Public function Const int32  
Protected function FOnlineLeaderboardsSteam * INTERNAL Get the interface for accessing leaderboards/stats
Public function Virtual Const FOnlinePingSteamPtr  
Public function Const uint32  
Protected function FSteamUserCloudData *

GetUserCloudEntry ( const FUniqueNetId& UserId
)

 INTERNAL Get the metadata related to a given user This information is only available after calling EnumerateUserFiles
Protected function bool

InitSteamworksClient ( bool bRelaunchInSteam,
int32 SteamAppId
)

 Initialize the client side APIs for Steam
Protected function bool Initialize the server side APIs for Steam
Public function bool 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
Public function bool 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
Public function Const bool  
Protected function void Add an async task onto the outgoing task queue for processing
Protected function void Add an async task onto the task queue for processing
Public function Virtual void  
Protected function void Shutdown the Steam APIs
Public function Virtual void  

Overridden from IOnlineSubsystem

  Type Name Description
Public function Virtual bool

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

 Exec handler that allows the online subsystem to process exec commands
Public function Virtual Const IOnlineAchievementsPtr Get the interface for accessing online achievements
Public function Virtual Const FString Each online subsystem has a global id for the app
Public function Virtual Const IOnlineChatPtr Get the interface for user-user and user-room chat functionality
Public function Virtual Const IOnlineEntitlementsPtr Get the interface for accessing user entitlements
Public function Virtual Const IOnlineEventsPtr Get the interface for accessing online achievements
Public function Virtual Const IOnlineExternalUIPtr Get the interface for accessing the external UIs of a service
Public function Virtual Const IOnlineFriendsPtr Get the interface for accessing the player friends services
Public function Virtual Const IOnlineGroupsPtr IOnlineSubsystem.
Public function Virtual Const IOnlineIdentityPtr Get the interface for accessing identity online services
Public function Virtual Const IOnlineLeaderboardsPtr Get the interface for accessing leaderboards/rankings of a service
Public function Virtual Const IOnlineMessagePtr Get the interface for accessing online messages
Public function Virtual Const FText  
Public function Virtual Const IOnlinePartyPtr Get the interface for accessing the player party services
Public function Virtual Const IOnlinePresencePtr Get the interface for managing rich presence information
Public function Virtual Const IOnlinePurchasePtr Get the interface for purchasing
Public function Virtual Const IOnlineSessionPtr Get the interface for accessing the session management services
Public function Virtual Const IOnlineSharedCloudPtr Get the interface for sharing user files in the cloud
Public function Virtual Const IOnlineSharingPtr Get the interface for accessing online sharing
Public function Virtual Const IOnlineStatsPtr Get the interface for accessing online stats
Public function Virtual Const IOnlineStoreV2Ptr Get the interface for accessing an online store
Public function Virtual Const IOnlineTimePtr Get the interface for accessing the server time from an online service
Public function Virtual Const IOnlineTitleFilePtr Get the interface for accessing title file online services
Public function Virtual Const IOnlineTournamentPtr Get the interface for managing tournament information
Public function Virtual Const IOnlineTurnBasedPtr Get the interface for managing turn based multiplayer games
Public function Virtual Const IOnlineUserCloudPtr Get the interface for accessing user files in the cloud
Public function Virtual Const IOnlineUserPtr Get the interface for accessing online user information
Public function Virtual Const IOnlineVoicePtr Get the interface for accessing voice related data
Public function Virtual bool

Init ()

 Initialize the underlying subsystem APIs
Public function Virtual Const bool  
Public function Virtual Const bool

IsLocalPlayer ( const FUniqueNetId& UniqueId
)

 Is a player local to this machine by unique id
Public function Virtual bool Shutdown the underlying subsystem APIs

Overridden from FTSTickerObjectBase

  Type Name Description
Public function Virtual bool

Tick ( float DeltaTime
)

 FTSTickerObjectBase.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page