class

IOnlineService

Module
Networking
Header
#include "Networking/OnlineService.h"
Namespace
Mowo

Constructors

SignatureNameDescription
virtual ~IOnlineService() = default~IOnlineService

Public functions

ReturnsNameDescription
const char*Name
boolInitLifecycle.
voidUpdate
voidShutdown
boolIsAvailable
boolIsReady
uint64_tGetLocalUserIdIdentity / entitlements — the primary-platform surface.
boolIsDlcInstalled
boolBeginAuthorizationExplicit user-consent sign-in (Discord OAuth2 PKCE).
boolIsAuthorized
std::unique_ptr<INetworkTransport>CreateP2PTransportP2P relay transport.
boolSetNetworkSimulationNetwork emulation.
boolCreateLobbyLobby / session advertisement.
boolJoinLobby
voidLeaveLobby
boolIsInLobby
uint64_tGetCurrentLobbyId
uint64_tGetLobbyHostId
boolRequestLobbyList
voidAdvertiseSession
voidClearAdvertisement
boolSetLobbyDataLobby metadata the host publishes for matchmaking filters and the lobby screen (map, difficulty, build).
std::stringGetLobbyData
boolSetLobbyJoinableCloses the lobby to new joiners once a run has started, reopens it for the next one.
std::vector<FOnlineLobbyMember>GetLobbyMembers
std::vector<FOnlineFriend>GetFriendsFriends and session invites on a social platform (Discord).
boolSendSessionInviteSends a join invite for the session this player advertised.
std::vector<uint64_t>GetPendingSessionInvitesSenders of invites received and not yet accepted.
boolAcceptSessionInvite
boolUploadLeaderboardScoreLeaderboards.
boolDownloadLeaderboard
voidSetRichPresenceRich presence.
voidClearRichPresence
voidSetRichPresenceValueOne raw presence key.
voidSetPresenceGroupThe party this player is in, so the friends list groups everyone in one session together and shows how many of them there are.
boolAreStatsReadyStats / achievements.
boolUnlockAchievement
boolClearAchievement
boolGetAchievement
boolSetStatInt
boolSetStatFloat
boolGetStatInt
boolGetStatFloat
boolIndicateAchievementProgressThe platform's own "3 / 10" progress popup.
boolStoreStats
voidSetStatsCallbacksonReceived fires when the player's values arrive (true) or fail to; onStored fires per achievement the server confirmed unlocked.
boolInitActionInputAction-based controller input (Steam Input).
boolIsActionInputAvailable
voidActivateActionSet
voidActivateActionSetLayer
voidDeactivateActionSetLayer
voidDeactivateAllActionSetLayers
boolGetDigitalAction
boolGetAnalogAction
std::stringGetActionGlyphPathThe first physical input bound to the action in the active set, as the platform's glyph image path and as display text ("A Button", "Right Trigger").
std::stringGetActionOriginText
boolTriggerRumble0..1 per motor; 0 and 0 stops it.
boolShowControllerBindingPanel
int32_tGetRemotePlaySessionCountRemote Play (Steam Remote Play / Remote Play Together): who is streaming this game from the host's machine right now.
uint32_tGetRemotePlaySessionId
uint64_tGetRemotePlaySessionUser
boolSendRemotePlayTogetherInvite
boolShowInviteDialogThe platform overlay's invite dialog for the current lobby (or session connect string) and whether the overlay can open at all — a player who turned it off gets the game's own UI instead.
boolIsOverlayEnabled
std::vector<FOnlineUgcItem>GetSubscribedUgcItemsWorkshop / user-generated content.
boolSubscribeUgcItem
boolUnsubscribeUgcItem
boolDownloadUgcItem
voidSetUgcInstalledCallbackFires when an item finishes installing or updating while the game runs.
boolRequestSessionTicketEncrypted session ticket — the client side of the dedicated-server auth gate.
voidSetOverlayCallbackPlatform overlay (Steam's in-game overlay).
boolIsOverlayActive
boolShowTextInputOn-screen keyboard (Deck Verified requires one for every text field a controller can reach).
boolIsTextInputShowing
std::stringGetGamepadFamilyThe pad family the platform sees ("SteamDeck", "Xbox", "PlayStation", "Switch", "SteamController"; empty when unknown) and the path of its glyph image for a button, empty when the platform ships none — the game falls back to its own art keyed by family.
std::stringGetGamepadGlyphPath
FOnlineVoiceSettingsGetVoiceSettingsThe platform voice client's mute / deafen / input mode.
ISocialVoiceCalls*GetSocialVoice
ISocialLobbies*GetSocialLobbies
ISocialAccounts*GetSocialAccounts
ISocialRelationships*GetSocialRelationships
boolSetActivity
voidSetTimelineModeGame recording timeline (Steam Timeline).
uint64_tAddTimelineEvent
voidRemoveTimelineEvent
voidSetTimelineTooltip
voidClearTimelineTooltip
voidStartGamePhase
voidEndGamePhase
EOnlinePlatformHardwareGetPlatformHardwareThe device the platform says this is, and the settings profile it recommends for it.
EOnlineHardwareDefaultConfigGetHardwareDefaultConfig
boolIsCompatibilityLayer
boolIsCloudAvailableCloud save files (SaveGame slots).
boolCloudWrite
boolCloudExists
int32_tCloudGetFileSize
boolCloudRead
int32_tCloudGetFileCount
std::stringCloudGetFileNameAndSize

Function details

~IOnlineService

C++
virtual ~IOnlineService() = default

Name

C++
virtual const char* Name() const = 0

Init

C++
virtual bool Init(const FPlatformInitParams& params) = 0

Lifecycle. Init receives the project's platform settings and returns true when the service came up (it self-gates on its own enable flag in the params). Update runs once per frame from the engine loop.

Update

C++
virtual void Update()

Shutdown

C++
virtual void Shutdown()

IsAvailable

C++
virtual bool IsAvailable() const

IsReady

C++
virtual bool IsReady() const

GetLocalUserId

C++
virtual uint64_t GetLocalUserId() const

Identity / entitlements — the primary-platform surface.

IsDlcInstalled

C++
virtual bool IsDlcInstalled(uint32_t productId) const

BeginAuthorization

C++
virtual bool BeginAuthorization()

Explicit user-consent sign-in (Discord OAuth2 PKCE). Platforms with ambient identity (Steam) don't implement these; BeginAuthorization returns true when the consent flow was started, IsAuthorized flips once the user completes it.

IsAuthorized

C++
virtual bool IsAuthorized() const

CreateP2PTransport

C++
virtual std::unique_ptr<INetworkTransport> CreateP2PTransport()

P2P relay transport. Non-null when the platform can carry game traffic (Steam SDR); the composite transport owns the result.

SetNetworkSimulation

C++
virtual bool SetNetworkSimulation(const FNetSimSettings& settings)

Network emulation. The engine's own injector only reaches the ENet backend — a platform relay carries its traffic inside the SDK, so the same net.sim.* cvars have to be handed to the platform's own fake-loss / fake-lag knobs through here rather than by including its header up in Networking. Returns true when the platform applied them.

CreateLobby

C++
virtual bool CreateLobby(int32_t maxMembers)

Lobby / session advertisement.

JoinLobby

C++
virtual bool JoinLobby(uint64_t lobbyId)

LeaveLobby

C++
virtual void LeaveLobby()

IsInLobby

C++
virtual bool IsInLobby() const

GetCurrentLobbyId

C++
virtual uint64_t GetCurrentLobbyId() const

GetLobbyHostId

C++
virtual uint64_t GetLobbyHostId() const

RequestLobbyList

C++
virtual bool RequestLobbyList(std::function<void(const std::vector<FPlatformLobbyInfo>&)> callback)

AdvertiseSession

C++
virtual void AdvertiseSession(const std::string& sessionName, int32_t maxMembers)

ClearAdvertisement

C++
virtual void ClearAdvertisement()

SetLobbyData

C++
virtual bool SetLobbyData(const std::string& key, const std::string& value)

Lobby metadata the host publishes for matchmaking filters and the lobby screen (map, difficulty, build). Host only; a non-host or a platform without lobbies returns false and reads back empty.

GetLobbyData

C++
virtual std::string GetLobbyData(const std::string& key) const

SetLobbyJoinable

C++
virtual bool SetLobbyJoinable(bool joinable)

Closes the lobby to new joiners once a run has started, reopens it for the next one. Host only.

GetLobbyMembers

C++
virtual std::vector<FOnlineLobbyMember> GetLobbyMembers() const

GetFriends

C++
virtual std::vector<FOnlineFriend> GetFriends() const

Friends and session invites on a social platform (Discord). The list is read from the client's cache, so it is empty until the platform is ready and the player has authorized with social scopes.

SendSessionInvite

C++
virtual bool SendSessionInvite(uint64_t userId, const std::string& message, std::function<void(bool)> done)

Sends a join invite for the session this player advertised. done receives the platform's verdict; false from the call means nothing was sent and done will not fire.

GetPendingSessionInvites

C++
virtual std::vector<uint64_t> GetPendingSessionInvites() const

Senders of invites received and not yet accepted. AcceptSessionInvite joins through the same path as a platform "Join Game".

AcceptSessionInvite

C++
virtual bool AcceptSessionInvite(uint64_t senderId)

UploadLeaderboardScore

C++
virtual bool UploadLeaderboardScore(const std::string& board, int32_t score, bool keepBest, std::function<void(bool)> done)

Leaderboards. Both calls are asynchronous and the callback fires on the thread that pumps Update(); false from the call itself means nothing was started (no platform, or the board name is empty) and the callback will not fire. Scores are integers (milliseconds for a best time).

DownloadLeaderboard

C++
virtual bool DownloadLeaderboard(const std::string& board, EOnlineLeaderboardRange range, int32_t first, int32_t count, std::function<void(bool, const std::vector<FOnlineLeaderboardEntry>&)> done)

SetRichPresence

C++
virtual void SetRichPresence(const std::string& details, const std::string& state)

Rich presence. Formatting ({details}/{state} expansion) happens in the caller; each service maps the pair onto its own fields.

ClearRichPresence

C++
virtual void ClearRichPresence()

SetRichPresenceValue

C++
virtual void SetRichPresenceValue(const std::string& key, const std::string& value)

One raw presence key. Steam shows only steam_display in the friends list — a "#Token" from the localisation file uploaded on the partner site, whose %key% placeholders are filled from other keys set here.

SetPresenceGroup

C++
virtual void SetPresenceGroup(const std::string& groupId, int32_t groupSize)

The party this player is in, so the friends list groups everyone in one session together and shows how many of them there are. An empty group id clears it.

AreStatsReady

C++
virtual bool AreStatsReady() const

Stats / achievements. Writes land in the client's local copy; StoreStats uploads them (FAchievements debounces it). AreStatsReady is false until the platform has handed the player's current values over; a write before that is refused, and FAchievements keeps it queued instead.

UnlockAchievement

C++
virtual bool UnlockAchievement(const std::string& id)

ClearAchievement

C++
virtual bool ClearAchievement(const std::string& id)

GetAchievement

C++
virtual bool GetAchievement(const std::string& id, bool& outUnlocked) const

SetStatInt

C++
virtual bool SetStatInt(const std::string& id, int32_t value)

SetStatFloat

C++
virtual bool SetStatFloat(const std::string& id, float value)

GetStatInt

C++
virtual bool GetStatInt(const std::string& id, int32_t& outValue) const

GetStatFloat

C++
virtual bool GetStatFloat(const std::string& id, float& outValue) const

IndicateAchievementProgress

C++
virtual bool IndicateAchievementProgress(const std::string& id, uint32_t current, uint32_t max)

The platform's own "3 / 10" progress popup. It does not unlock anything.

StoreStats

C++
virtual bool StoreStats()

SetStatsCallbacks

C++
virtual void SetStatsCallbacks(std::function<void(bool)> onReceived, std::function<void(const std::string&)> onStored)

onReceived fires when the player's values arrive (true) or fail to; onStored fires per achievement the server confirmed unlocked.

InitActionInput

C++
virtual bool InitActionInput()

Action-based controller input (Steam Input). Action sets and actions are named as in the game's controller configuration; the engine names them after its input contexts and actions so one name means one thing on both paths. False / empty whenever the platform has no controller under its control, so the caller keeps reading the pad itself.

IsActionInputAvailable

C++
virtual bool IsActionInputAvailable() const

ActivateActionSet

C++
virtual void ActivateActionSet(const std::string& actionSet)

ActivateActionSetLayer

C++
virtual void ActivateActionSetLayer(const std::string& layer)

DeactivateActionSetLayer

C++
virtual void DeactivateActionSetLayer(const std::string& layer)

DeactivateAllActionSetLayers

C++
virtual void DeactivateAllActionSetLayers()

GetDigitalAction

C++
virtual bool GetDigitalAction(const std::string& action, bool& outPressed) const

GetAnalogAction

C++
virtual bool GetAnalogAction(const std::string& action, float& outX, float& outY) const

GetActionGlyphPath

C++
virtual std::string GetActionGlyphPath(const std::string& action) const

The first physical input bound to the action in the active set, as the platform's glyph image path and as display text ("A Button", "Right Trigger"). Empty when the action is unbound or unknown.

GetActionOriginText

C++
virtual std::string GetActionOriginText(const std::string& action) const

TriggerRumble

C++
virtual bool TriggerRumble(float lowFrequency, float highFrequency)

0..1 per motor; 0 and 0 stops it.

ShowControllerBindingPanel

C++
virtual bool ShowControllerBindingPanel()

GetRemotePlaySessionCount

C++
virtual int32_t GetRemotePlaySessionCount() const

Remote Play (Steam Remote Play / Remote Play Together): who is streaming this game from the host's machine right now.

GetRemotePlaySessionId

C++
virtual uint32_t GetRemotePlaySessionId(int32_t index) const

GetRemotePlaySessionUser

C++
virtual uint64_t GetRemotePlaySessionUser(uint32_t sessionId) const

SendRemotePlayTogetherInvite

C++
virtual bool SendRemotePlayTogetherInvite(uint64_t friendId)

ShowInviteDialog

C++
virtual bool ShowInviteDialog()

The platform overlay's invite dialog for the current lobby (or session connect string) and whether the overlay can open at all — a player who turned it off gets the game's own UI instead.

IsOverlayEnabled

C++
virtual bool IsOverlayEnabled() const

GetSubscribedUgcItems

C++
virtual std::vector<FOnlineUgcItem> GetSubscribedUgcItems() const

Workshop / user-generated content.

SubscribeUgcItem

C++
virtual bool SubscribeUgcItem(uint64_t itemId)

UnsubscribeUgcItem

C++
virtual bool UnsubscribeUgcItem(uint64_t itemId)

DownloadUgcItem

C++
virtual bool DownloadUgcItem(uint64_t itemId, bool highPriority)

SetUgcInstalledCallback

C++
virtual void SetUgcInstalledCallback(std::function<void(uint64_t)> callback)

Fires when an item finishes installing or updating while the game runs.

RequestSessionTicket

C++
virtual bool RequestSessionTicket(std::function<void(const std::vector<uint8_t>&, bool)> callback)

Encrypted session ticket — the client side of the dedicated-server auth gate. The callback receives the ticket bytes and a success flag.

SetOverlayCallback

C++
virtual void SetOverlayCallback(std::function<void(bool)> callback)

Platform overlay (Steam's in-game overlay). Opening it takes the keyboard and the mouse inside the SDK, so the engine sees no focus loss and no window event: without this notification a single-player world keeps ticking under a modal the player cannot reach and the camera keeps following a mouse the player is using to browse the store. The callback fires once per transition; IsOverlayActive is the same state for code that polls.

IsOverlayActive

C++
virtual bool IsOverlayActive() const

ShowTextInput

C++
virtual bool ShowTextInput(const FOnlineTextInputRequest& request, std::function<void(const FOnlineTextInputResult&)> onDone)

On-screen keyboard (Deck Verified requires one for every text field a controller can reach). False when the platform has none or refused; onDone runs once, when the keyboard closes.

IsTextInputShowing

C++
virtual bool IsTextInputShowing() const

GetGamepadFamily

C++
virtual std::string GetGamepadFamily() const

The pad family the platform sees ("SteamDeck", "Xbox", "PlayStation", "Switch", "SteamController"; empty when unknown) and the path of its glyph image for a button, empty when the platform ships none — the game falls back to its own art keyed by family.

GetGamepadGlyphPath

C++
virtual std::string GetGamepadGlyphPath(EOnlineGamepadButton button) const

GetVoiceSettings

C++
virtual FOnlineVoiceSettings GetVoiceSettings() const

The platform voice client's mute / deafen / input mode. Valid is false until the platform has answered.

GetSocialVoice

C++
virtual ISocialVoiceCalls* GetSocialVoice()

GetSocialLobbies

C++
virtual ISocialLobbies* GetSocialLobbies()

GetSocialAccounts

C++
virtual ISocialAccounts* GetSocialAccounts()

GetSocialRelationships

C++
virtual ISocialRelationships* GetSocialRelationships()

SetActivity

C++
virtual bool SetActivity(const FSocialActivity& activity)

SetTimelineMode

C++
virtual void SetTimelineMode(EOnlineTimelineMode mode)

Game recording timeline (Steam Timeline). Events mark the moments a player may want to clip — a death, a scare, an extraction — with a Steam icon name ("steam_death", "steam_effect", ...) or a custom icon uploaded on the partner site. A duration of 0 is an instant; the returned handle (0 when unsupported) removes the event again. A game phase groups a round or a match so the overlay can offer it as one recording.

AddTimelineEvent

C++
virtual uint64_t AddTimelineEvent(const std::string& title, const std::string& description, const std::string& icon, uint32_t priority, float startOffsetSeconds, float durationSeconds, EOnlineClipPriority clip)

RemoveTimelineEvent

C++
virtual void RemoveTimelineEvent(uint64_t handle)

SetTimelineTooltip

C++
virtual void SetTimelineTooltip(const std::string& description)

ClearTimelineTooltip

C++
virtual void ClearTimelineTooltip()

StartGamePhase

C++
virtual void StartGamePhase(const std::string& phaseId)

EndGamePhase

C++
virtual void EndGamePhase()

GetPlatformHardware

C++
virtual EOnlinePlatformHardware GetPlatformHardware() const

The device the platform says this is, and the settings profile it recommends for it. IsCompatibilityLayer is Proton on Steam.

GetHardwareDefaultConfig

C++
virtual EOnlineHardwareDefaultConfig GetHardwareDefaultConfig() const

IsCompatibilityLayer

C++
virtual bool IsCompatibilityLayer() const

IsCloudAvailable

C++
virtual bool IsCloudAvailable() const

Cloud save files (SaveGame slots).

CloudWrite

C++
virtual bool CloudWrite(const std::string& name, const void* data, int32_t size)

CloudExists

C++
virtual bool CloudExists(const std::string& name) const

CloudGetFileSize

C++
virtual int32_t CloudGetFileSize(const std::string& name) const

CloudRead

C++
virtual bool CloudRead(const std::string& name, void* buffer, int32_t size) const

CloudGetFileCount

C++
virtual int32_t CloudGetFileCount() const

CloudGetFileNameAndSize

C++
virtual std::string CloudGetFileNameAndSize(int32_t index, int32_t& outSize) const
Generated from Networking/OnlineService.h via networking.json · Nov 4, 2026Version 1.0.0