Language:
Discover
By Skill Level
By Category

FOnlineSubsystemSteam

Choose your OS:

Inheritance Hierarchy

IOnlineSubsystem

FOnlineSubsystemImpl

FOnlineSubsystemSteam

Syntax

class FOnlineSubsystemSteam : public FOnlineSubsystemImpl

Remarks

OnlineSubsystemSteam - Implementation of the online subsystem for STEAM services

Variables

Name Description

Protected variable

FOnlineAchievem ...

 

AchievementsInterface

Interface for achievements

Protected variable

FOnlineAuthStea ...

 

AuthInterface

Interface for Steam Session Auth

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

 

bVoiceInterfaceInitialized

Interface for voice communication

Protected variable

FOnlineExternal...

 

ExternalUIInterface

Interface to the external UI services

Protected variable

FOnlineFriendsS...

 

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

int32

 

GameServerSteamPort

Steam port - the local port used to communicate with the steam servers

Protected variable

FOnlineIdentity...

 

IdentityInterface

Interface to the profile services

Protected variable

FOnlineLeaderbo...

 

LeaderboardsInterface

Interface to the leaderboard services

Protected variable

FRunnableThread ...

 

OnlineAsyncTaskThread

Online async task thread

Protected variable

FOnlineAsyncTas...

 

OnlineAsyncTaskThreadRunnable

Online async task runnable

Protected variable

FOnlinePresence...

 

PresenceInterface

Interface for presence

Protected variable

FOnlineSessionS...

 

SessionInterface

Interface to the session services

Protected variable

FOnlineSharedCl...

 

SharedCloudInterface

Interface to the shared cloud services

Protected variable

uint32

 

SteamAppID

Steam App ID for the running game

Protected variable

TArray < struct ...

 

UserCloudData

Array of the files in the cloud for a given user

Protected variable

FCriticalSectio ...

 

UserCloudDataLock

Critical sections for thread safe operation of the cloud files

Protected variable

FOnlineUserClou...

 

UserCloudInterface

Interface to the user cloud services

Protected variable

IOnlineVoicePtr

 

VoiceInterface

Interface to the voice engine

Constructors

Name Description

Protected function

FOnlineSubsystemSteam()

Only the factory makes instances

Protected function

FOnlineSubsystemSteam

(
    FName InInstanceName
)

Destructors

Name Description

Public function Virtual

~FOnlineSubsystemSteam()

Functions

Name Description

Protected function

void

 

ClearUserCloudFiles()

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

FOnlineAuthS ...

 

GetAuthInterface()

Public function

int32

 

GetGameServerGamePort()

The port the game has registered for play

Public function

int32

 

GetGameServerQueryPort()

The port the game has registered for incoming server queries

Public function

int32

 

GetGameServerSteamPort()

The port the game has registered for talking to Steam

Protected function

FOnlineLeade...

 

GetInternalLeaderboardsInterface()

INTERNAL Get the interface for accessing leaderboards/stats

Public function

uint32

 

GetSteamAppId()

The steam app id for this app

Protected function

FSteamUserCl...

 

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

 

InitSteamworksServer()

Initialize the server side APIs for Steam

Public function

bool

 

IsSteamClientAvailable()

FOnlineSubsystemSteam .

Public function

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

Protected function

void

 

QueueAsyncOutgoingItem

(
    FOnlineAsyncItem * AsyncItem
)

Add an async task onto the outgoing task queue for processing

Protected function

void

 

QueueAsyncTask

(
    FOnlineAsyncTask * AsyncTask
)

Add an async task onto the task queue for processing

Protected function

void

 

ShutdownSteamworks()

Shutdown the Steam APIs

Overridden from FOnlineSubsystemImpl

Name Description

Public function Virtual

bool

 

Tick

(
    float DeltaTime
)

FTickerObjectBase .

Overridden from IOnlineSubsystem

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

IOnlineAchie ...

 

GetAchievementsInterface()

Get the interface for accessing online achievements

Public function Virtual

FString

 

GetAppId()

Each online subsystem has a global id for the app

the app id for this app

Public function Virtual

IOnlineChatP ...

 

GetChatInterface()

Get the interface for user-user and user-room chat functionality

Public function Virtual

IOnlineEntit ...

 

GetEntitlementsInterface()

Get the interface for accessing user entitlements

Public function Virtual

IOnlineEvent ...

 

GetEventsInterface()

Get the interface for accessing online achievements

Public function Virtual

IOnlineExter ...

 

GetExternalUIInterface()

Get the interface for accessing the external UIs of a service

Public function Virtual

IOnlineFrien ...

 

GetFriendsInterface()

Get the interface for accessing the player friends services

Public function Virtual

IOnlineGroup ...

 

GetGroupsInterface()

Get the interface for accessing the groups services

Public function Virtual

IOnlineIdent ...

 

GetIdentityInterface()

Get the interface for accessing identity online services

Public function Virtual

IOnlineLeade ...

 

GetLeaderboardsInterface()

Get the interface for accessing leaderboards/rankings of a service

Public function Virtual

IOnlineMessa ...

 

GetMessageInterface()

Get the interface for accessing online messages

Public function Virtual

FText

 

GetOnlineServiceName()

The name of the online service this platform uses

Public function Virtual

IOnlineParty ...

 

GetPartyInterface()

Get the interface for accessing the player party services

Public function Virtual

IOnlinePrese ...

 

GetPresenceInterface()

Get the interface for managing rich presence information

Public function Virtual

IOnlinePurch ...

 

GetPurchaseInterface()

Get the interface for purchasing

Interface pointer for the appropriate purchase service

Public function Virtual

IOnlineSessi ...

 

GetSessionInterface()

IOnlineSubsystem .

Public function Virtual

IOnlineShare ...

 

GetSharedCloudInterface()

Get the interface for sharing user files in the cloud

Public function Virtual

IOnlineShari ...

 

GetSharingInterface()

Get the interface for accessing online sharing

Public function Virtual

IOnlineStore ...

 

GetStoreInterface()

Get the interface for accessing an online store

Public function Virtual

IOnlineStore ...

 

GetStoreV2Interface()

Get the interface for accessing an online store

Public function Virtual

IOnlineTimeP ...

 

GetTimeInterface()

Get the interface for accessing the server time from an online service

Public function Virtual

IOnlineTitle ...

 

GetTitleFileInterface()

Get the interface for accessing title file online services

Public function Virtual

IOnlineTourn ...

 

GetTournamentInterface()

Get the interface for managing tournament information

Public function Virtual

IOnlineTurnB ...

 

GetTurnBasedInterface()

Get the interface for managing turn based multiplayer games

Public function Virtual

IOnlineUserC ...

 

GetUserCloudInterface()

Get the interface for accessing user files in the cloud

Public function Virtual

IOnlineUserP ...

 

GetUserInterface()

Get the interface for accessing online user information

Public function Virtual

IOnlineVoice ...

 

GetVoiceInterface()

Get the interface for accessing voice related data

Public function Virtual

bool

 

Init()

Initialize the underlying subsystem APIs

Public function Virtual

bool

 

IsEnabled()

True if the subsystem is enabled, false otherwise

Public function Virtual

bool

 

IsLocalPlayer

(
    const FUniqueNetId & UniqueId
)

Is a player local to this machine by unique id

Public function Virtual

bool

 

Shutdown()

Shutdown the underlying subsystem APIs

References