class

MPlatformSubsystem

Module
Networking
Header
#include "Networking/Subsystems/MPlatformSubsystem.h"
Namespace
Mowo
Reflection
Reflected by MowoHeaderTool

Public functions

ReturnsNameDescription
voidSetRichPresencepresenceStateFormat ("{details}" / "{state}" tokens).
voidClearRichPresence
voidSetRichPresenceValueOne raw presence key ("steam_display", or a %key% the display token's localisation reads) and the party grouping the friends list shows.
voidSetPresenceGroup
boolUnlockAchievementAchievements and stats through FAchievements: recorded locally at once (the game reads them back with no platform up, PIE included) and handed to Steam when it has the player's values, uploaded on a short debounce and at exit.
boolClearAchievement
boolIsAchievementUnlocked
boolSetStatInt
boolSetStatFloat
boolAddStatInt
intGetStatInt
floatGetStatFloat
boolIndicateAchievementProgressThe platform's "current / max" popup; does not unlock.
voidStoreStatsUpload now instead of after the debounce (end of a run, before a quit prompt).
std::stringPopUnlockedAchievementThe next achievement this session unlocked, oldest first; empty when none is waiting.
intGetPendingAchievementWritesWrites waiting for the platform (offline, or its stats not loaded yet).
boolIsSteamInputActiveSteam Input.
voidActivateActionSet
voidActivateActionSetLayer
voidDeactivateActionSetLayer
voidDeactivateAllActionSetLayers
std::stringGetActionGlyphPath
std::stringGetActionOriginText
boolTriggerRumble
boolShowControllerBindingPanel
intGetRemotePlaySessionCountRemote Play Together: guests streaming this game from the host.
uint64_tGetRemotePlaySessionUserAt
boolInviteToRemotePlayTogether
boolShowInviteDialogThe overlay's invite dialog for the current lobby or session.
boolIsOverlayEnabled
intRefreshWorkshopItemsWorkshop.
uint64_tGetWorkshopItemIdAt
boolIsWorkshopItemInstalledAt
std::stringGetWorkshopItemFolderAt
floatGetWorkshopItemProgressAt
boolSubscribeWorkshopItem
boolUnsubscribeWorkshopItem
boolDownloadWorkshopItem
voidCreateLobbySteam lobbies.
voidJoinLobby
voidLeaveLobby
boolIsInLobby
uint64_tGetCurrentLobbyId
uint64_tGetLobbyHostSteamIdSteamID64 of the current lobby's owner (the host), or 0 when not in a lobby.
voidRefreshLobbyListServer browser.
boolIsLobbyListPending
intGetLobbyListCount
uint64_tGetLobbyIdAt
uint64_tGetLobbyHostAt
std::stringGetLobbyNameAt
intGetLobbyMemberCountAt
intGetLobbyMaxMembersAt
boolSetLobbyDataLobby metadata and roster.
std::stringGetLobbyData
boolSetLobbyJoinable
intGetLobbyRosterCount
uint64_tGetLobbyRosterIdAt
std::stringGetLobbyRosterNameAt
boolIsLobbyRosterHostAt
intGetDiscordFriendCountDiscord friends and join invites.
uint64_tGetDiscordFriendIdAt
std::stringGetDiscordFriendNameAt
intGetDiscordFriendPresenceAt
boolSendDiscordInvite
intGetPendingDiscordInviteCount
uint64_tGetPendingDiscordInviteSenderAt
boolAcceptDiscordInvite
boolCreateDiscordLobbyDiscord lobbies.
boolJoinDiscordLobbyBySecret
voidLeaveDiscordLobby
boolIsInDiscordLobby
uint64_tGetDiscordLobbyId
std::stringGetDiscordLobbySecret
uint64_tGetDiscordLobbyOwnerId
boolSetDiscordLobbyData
std::stringGetDiscordLobbyData
boolSetDiscordLobbyJoinable
intGetDiscordLobbyMemberCount
uint64_tGetDiscordLobbyMemberIdAt
std::stringGetDiscordLobbyMemberNameAt
boolInviteToDiscordLobby
boolTransferDiscordLobbyOwnership
boolStartDiscordCallDiscord voice call of the current lobby.
voidEndDiscordCall
intGetDiscordCallStatus
boolIsInDiscordCall
voidSetDiscordSelfMute
voidSetDiscordSelfDeaf
boolIsDiscordSelfMuted
boolIsDiscordSelfDeaf
intGetDiscordCallParticipantCount
uint64_tGetDiscordCallParticipantIdAt
std::stringGetDiscordCallParticipantNameAt
boolIsDiscordCallParticipantSpeakingAt
boolIsDiscordCallParticipantMutedAt
floatGetDiscordCallParticipantVolumeAt
boolSetDiscordParticipantVolume
boolSetDiscordParticipantMuted
voidSetDiscordVoiceMode
voidSetDiscordPushToTalk
voidApplyDiscordVoiceOptions
voidRefreshDiscordAudioDevices
intGetDiscordInputDeviceCount
std::stringGetDiscordInputDeviceIdAt
std::stringGetDiscordInputDeviceNameAt
intGetDiscordOutputDeviceCount
std::stringGetDiscordOutputDeviceIdAt
std::stringGetDiscordOutputDeviceNameAt
boolSetDiscordInputDevice
boolSetDiscordOutputDevice
voidRefreshDiscordGuildsLinked channels: mirror the lobby's chat to a channel of a server the player belongs to.
intGetDiscordGuildCount
uint64_tGetDiscordGuildIdAt
std::stringGetDiscordGuildNameAt
voidRefreshDiscordGuildChannels
intGetDiscordChannelCount
uint64_tGetDiscordChannelIdAt
std::stringGetDiscordChannelNameAt
boolIsDiscordChannelLinkableAt
boolLinkDiscordChannel
boolUnlinkDiscordChannel
uint64_tGetLinkedDiscordChannelId
std::stringGetLinkedDiscordChannelName
boolSignInDiscordSign-in beyond the plain AuthorizeDiscord: method 0 browser or overlay (PKCE), 1 device code, 2 provisional account (externalToken is the game's own identity token; no Discord account needed).
intGetDiscordAuthState
std::stringGetDiscordAuthFailure
voidSignOutDiscord
voidSetDiscordProvisionalName
intGetDiscordRelationshipCountRelationships.
uint64_tGetDiscordRelationshipIdAt
std::stringGetDiscordRelationshipNameAt
intGetDiscordRelationshipStateAt
intGetDiscordGameRelationshipStateAt
boolSendDiscordFriendRequest
boolAcceptDiscordFriendRequest
boolRejectDiscordFriendRequest
boolCancelDiscordFriendRequest
boolRemoveDiscordFriend
boolBlockDiscordUser
boolUnblockDiscordUser
boolSetDiscordActivityRich presence beyond details/state: party size, the join secret that puts Invite and Ask to Join on the card, timestamps, one link button.
boolUploadLeaderboardScoreLeaderboards.
boolWasLeaderboardUploadOk
boolRequestLeaderboard
boolIsLeaderboardPending
intGetLeaderboardCount
intGetLeaderboardRankAt
intGetLeaderboardScoreAt
std::stringGetLeaderboardNameAt
uint64_tGetLeaderboardUserAt
voidAdvertiseSessionHost side of the handoff — publish the host SteamID64 + session name so a friend's Join Game resolves to a Steam P2P address.
voidClearAdvertisement
voidConnectToHostLobby → session handoff.
voidEnableSteamJoinHandlingRoute Steam invites / friends-list "Join Game" into ConnectToHost, as the LAST resort: the session layer (FNetSession::EnableInviteHandling) takes precedence whenever a game has claimed the invite, because a bare transport connect gives the joiner no player record and no pawn.
boolIsSteamAvailable
boolIsDiscordReady
boolAuthorizeDiscordDiscord OAuth2 sign-in (PKCE, opens the overlay or a browser).
boolIsDiscordAuthorized
uint64_tAddTimelineEventSteam Timeline: mark the moments worth clipping.
voidRemoveTimelineEvent
voidSetTimelineMode0 playing, 1 staging (lobby, pre-round), 2 menus, 3 loading screen.
voidSetTimelineTooltip
voidClearTimelineTooltip
voidStartGamePhaseA round or a match, offered by the overlay as one recording.
voidEndGamePhase
std::stringGetPlatformHardware"none", "steam_deck", "steam_machine", "steam_frame" or "other".
intGetRecommendedQualityPresetThe quality preset (EQualityPreset value) the platform recommends for this device, or -1 when it has no opinion.
boolIsRunningUnderProton

Function details

SetRichPresence

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

presenceStateFormat ("{details}" / "{state}" tokens).

ClearRichPresence

C++
void ClearRichPresence()

SetRichPresenceValue

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

One raw presence key ("steam_display", or a %key% the display token's localisation reads) and the party grouping the friends list shows.

SetPresenceGroup

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

UnlockAchievement

C++
bool UnlockAchievement(const std::string& name)

Achievements and stats through FAchievements: recorded locally at once (the game reads them back with no platform up, PIE included) and handed to Steam when it has the player's values, uploaded on a short debounce and at exit. Ids are the API names Config/Achievements.ini declares.

ClearAchievement

C++
bool ClearAchievement(const std::string& name)

IsAchievementUnlocked

C++
bool IsAchievementUnlocked(const std::string& name) const

SetStatInt

C++
bool SetStatInt(const std::string& name, int value)

SetStatFloat

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

AddStatInt

C++
bool AddStatInt(const std::string& name, int delta)

GetStatInt

C++
int GetStatInt(const std::string& name) const

GetStatFloat

C++
float GetStatFloat(const std::string& name) const

IndicateAchievementProgress

C++
bool IndicateAchievementProgress(const std::string& name, int current, int max)

The platform's "current / max" popup; does not unlock.

StoreStats

C++
void StoreStats()

Upload now instead of after the debounce (end of a run, before a quit prompt).

PopUnlockedAchievement

C++
std::string PopUnlockedAchievement()

The next achievement this session unlocked, oldest first; empty when none is waiting. A graph polls it to show its own toast.

GetPendingAchievementWrites

C++
int GetPendingAchievementWrites() const

Writes waiting for the platform (offline, or its stats not loaded yet).

IsSteamInputActive

C++
bool IsSteamInputActive() const

Steam Input. Action sets and layers are the game's controller configuration names (the engine activates the set named after the bottom input context on its own; these are for a game that drives them by hand). Glyph and text answer for the first input bound to the action in the active set — empty when Steam Input does not own the pad, so the UI falls back to its own art.

ActivateActionSet

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

ActivateActionSetLayer

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

DeactivateActionSetLayer

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

DeactivateAllActionSetLayers

C++
void DeactivateAllActionSetLayers()

GetActionGlyphPath

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

GetActionOriginText

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

TriggerRumble

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

ShowControllerBindingPanel

C++
bool ShowControllerBindingPanel()

GetRemotePlaySessionCount

C++
int GetRemotePlaySessionCount() const

Remote Play Together: guests streaming this game from the host.

GetRemotePlaySessionUserAt

C++
uint64_t GetRemotePlaySessionUserAt(int index) const

InviteToRemotePlayTogether

C++
bool InviteToRemotePlayTogether(uint64_t friendId)

ShowInviteDialog

C++
bool ShowInviteDialog()

The overlay's invite dialog for the current lobby or session.

IsOverlayEnabled

C++
bool IsOverlayEnabled() const

RefreshWorkshopItems

C++
int RefreshWorkshopItems()

Workshop. RefreshWorkshopItems reads the subscribed list (cheap, no network); the accessors read that snapshot by index. Installed items load as mods (Mods/ModManager) on the next start; progress is 0..1.

GetWorkshopItemIdAt

C++
uint64_t GetWorkshopItemIdAt(int index) const

IsWorkshopItemInstalledAt

C++
bool IsWorkshopItemInstalledAt(int index) const

GetWorkshopItemFolderAt

C++
std::string GetWorkshopItemFolderAt(int index) const

GetWorkshopItemProgressAt

C++
float GetWorkshopItemProgressAt(int index) const

SubscribeWorkshopItem

C++
bool SubscribeWorkshopItem(uint64_t itemId)

UnsubscribeWorkshopItem

C++
bool UnsubscribeWorkshopItem(uint64_t itemId)

DownloadWorkshopItem

C++
bool DownloadWorkshopItem(uint64_t itemId)

CreateLobby

C++
void CreateLobby(int maxPlayers)

Steam lobbies. maxPlayers <= 0 uses platform.defaultMaxPlayers; visibility comes from platform.defaultLobbyType.

JoinLobby

C++
void JoinLobby(uint64_t lobbyId)

LeaveLobby

C++
void LeaveLobby()

IsInLobby

C++
bool IsInLobby() const

GetCurrentLobbyId

C++
uint64_t GetCurrentLobbyId() const

GetLobbyHostSteamId

C++
uint64_t GetLobbyHostSteamId() const

SteamID64 of the current lobby's owner (the host), or 0 when not in a lobby. This is the address the join side feeds to ConnectToHost.

RefreshLobbyList

C++
void RefreshLobbyList()

Server browser. RefreshLobbyList kicks the async request off; the rows land in the cache a moment later and the accessors read them, so a Visual Script graph can poll instead of needing a callback pin.

IsLobbyListPending

C++
bool IsLobbyListPending() const

GetLobbyListCount

C++
int GetLobbyListCount() const

GetLobbyIdAt

C++
uint64_t GetLobbyIdAt(int index) const

GetLobbyHostAt

C++
uint64_t GetLobbyHostAt(int index) const

GetLobbyNameAt

C++
std::string GetLobbyNameAt(int index) const

GetLobbyMemberCountAt

C++
int GetLobbyMemberCountAt(int index) const

GetLobbyMaxMembersAt

C++
int GetLobbyMaxMembersAt(int index) const

SetLobbyData

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

Lobby metadata and roster. SetLobbyData / SetLobbyJoinable are host only.

GetLobbyData

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

SetLobbyJoinable

C++
bool SetLobbyJoinable(bool joinable)

GetLobbyRosterCount

C++
int GetLobbyRosterCount() const

GetLobbyRosterIdAt

C++
uint64_t GetLobbyRosterIdAt(int index) const

GetLobbyRosterNameAt

C++
std::string GetLobbyRosterNameAt(int index) const

IsLobbyRosterHostAt

C++
bool IsLobbyRosterHostAt(int index) const

GetDiscordFriendCount

C++
int GetDiscordFriendCount() const

Discord friends and join invites. Friends need the player to have authorized (BeginAuthorization) with social scopes (discord.Social on); presence is 0 offline, 1 online elsewhere, 2 playing this game. An invite received from a friend is listed by sender id until accepted, and accepting it joins through the same path as a Steam "Join Game".

GetDiscordFriendIdAt

C++
uint64_t GetDiscordFriendIdAt(int index) const

GetDiscordFriendNameAt

C++
std::string GetDiscordFriendNameAt(int index) const

GetDiscordFriendPresenceAt

C++
int GetDiscordFriendPresenceAt(int index) const

SendDiscordInvite

C++
bool SendDiscordInvite(uint64_t userId, const std::string& message)

GetPendingDiscordInviteCount

C++
int GetPendingDiscordInviteCount() const

GetPendingDiscordInviteSenderAt

C++
uint64_t GetPendingDiscordInviteSenderAt(int index) const

AcceptDiscordInvite

C++
bool AcceptDiscordInvite(uint64_t senderId)

CreateDiscordLobby

C++
bool CreateDiscordLobby(int maxMembers)

Discord lobbies. The creator's client is the owner; the lobby secret (GetDiscordLobbySecret) is what a friend joins with, and invites carry it. Discord has no lobby search, so discovery is invites and the profile's Join button, not a list. Unverified against live Discord.

JoinDiscordLobbyBySecret

C++
bool JoinDiscordLobbyBySecret(const std::string& secret)

LeaveDiscordLobby

C++
void LeaveDiscordLobby()

IsInDiscordLobby

C++
bool IsInDiscordLobby() const

GetDiscordLobbyId

C++
uint64_t GetDiscordLobbyId() const

GetDiscordLobbySecret

C++
std::string GetDiscordLobbySecret() const

GetDiscordLobbyOwnerId

C++
uint64_t GetDiscordLobbyOwnerId() const

SetDiscordLobbyData

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

GetDiscordLobbyData

C++
std::string GetDiscordLobbyData(const std::string& key) const

SetDiscordLobbyJoinable

C++
bool SetDiscordLobbyJoinable(bool joinable)

GetDiscordLobbyMemberCount

C++
int GetDiscordLobbyMemberCount() const

GetDiscordLobbyMemberIdAt

C++
uint64_t GetDiscordLobbyMemberIdAt(int index) const

GetDiscordLobbyMemberNameAt

C++
std::string GetDiscordLobbyMemberNameAt(int index) const

InviteToDiscordLobby

C++
bool InviteToDiscordLobby(uint64_t userId, const std::string& message)

TransferDiscordLobbyOwnership

C++
bool TransferDiscordLobbyOwnership(uint64_t newOwnerId)

StartDiscordCall

C++
bool StartDiscordCall()

Discord voice call of the current lobby. Status: 0 disconnected, 1 joining, 2 connecting, 3 connected, 4 reconnecting, 5 disconnecting, 6 failed. Volumes: 1 is the default level (participants 0..2, input 0..1, output 0..2). Mode: 0 voice activity, 1 push to talk.

EndDiscordCall

C++
void EndDiscordCall()

GetDiscordCallStatus

C++
int GetDiscordCallStatus() const

IsInDiscordCall

C++
bool IsInDiscordCall() const

SetDiscordSelfMute

C++
void SetDiscordSelfMute(bool mute)

SetDiscordSelfDeaf

C++
void SetDiscordSelfDeaf(bool deaf)

IsDiscordSelfMuted

C++
bool IsDiscordSelfMuted() const

IsDiscordSelfDeaf

C++
bool IsDiscordSelfDeaf() const

GetDiscordCallParticipantCount

C++
int GetDiscordCallParticipantCount() const

GetDiscordCallParticipantIdAt

C++
uint64_t GetDiscordCallParticipantIdAt(int index) const

GetDiscordCallParticipantNameAt

C++
std::string GetDiscordCallParticipantNameAt(int index) const

IsDiscordCallParticipantSpeakingAt

C++
bool IsDiscordCallParticipantSpeakingAt(int index) const

IsDiscordCallParticipantMutedAt

C++
bool IsDiscordCallParticipantMutedAt(int index) const

GetDiscordCallParticipantVolumeAt

C++
float GetDiscordCallParticipantVolumeAt(int index) const

SetDiscordParticipantVolume

C++
bool SetDiscordParticipantVolume(uint64_t userId, float volume)

SetDiscordParticipantMuted

C++
bool SetDiscordParticipantMuted(uint64_t userId, bool muted)

SetDiscordVoiceMode

C++
void SetDiscordVoiceMode(int mode)

SetDiscordPushToTalk

C++
void SetDiscordPushToTalk(bool active)

ApplyDiscordVoiceOptions

C++
void ApplyDiscordVoiceOptions()

RefreshDiscordAudioDevices

C++
void RefreshDiscordAudioDevices()

GetDiscordInputDeviceCount

C++
int GetDiscordInputDeviceCount() const

GetDiscordInputDeviceIdAt

C++
std::string GetDiscordInputDeviceIdAt(int index) const

GetDiscordInputDeviceNameAt

C++
std::string GetDiscordInputDeviceNameAt(int index) const

GetDiscordOutputDeviceCount

C++
int GetDiscordOutputDeviceCount() const

GetDiscordOutputDeviceIdAt

C++
std::string GetDiscordOutputDeviceIdAt(int index) const

GetDiscordOutputDeviceNameAt

C++
std::string GetDiscordOutputDeviceNameAt(int index) const

SetDiscordInputDevice

C++
bool SetDiscordInputDevice(const std::string& deviceId)

SetDiscordOutputDevice

C++
bool SetDiscordOutputDevice(const std::string& deviceId)

RefreshDiscordGuilds

C++
void RefreshDiscordGuilds()

Linked channels: mirror the lobby's chat to a channel of a server the player belongs to. The lists are asynchronous; poll the counts.

GetDiscordGuildCount

C++
int GetDiscordGuildCount() const

GetDiscordGuildIdAt

C++
uint64_t GetDiscordGuildIdAt(int index) const

GetDiscordGuildNameAt

C++
std::string GetDiscordGuildNameAt(int index) const

RefreshDiscordGuildChannels

C++
void RefreshDiscordGuildChannels(uint64_t guildId)

GetDiscordChannelCount

C++
int GetDiscordChannelCount() const

GetDiscordChannelIdAt

C++
uint64_t GetDiscordChannelIdAt(int index) const

GetDiscordChannelNameAt

C++
std::string GetDiscordChannelNameAt(int index) const

IsDiscordChannelLinkableAt

C++
bool IsDiscordChannelLinkableAt(int index) const

LinkDiscordChannel

C++
bool LinkDiscordChannel(uint64_t channelId)

UnlinkDiscordChannel

C++
bool UnlinkDiscordChannel()

GetLinkedDiscordChannelId

C++
uint64_t GetLinkedDiscordChannelId() const

GetLinkedDiscordChannelName

C++
std::string GetLinkedDiscordChannelName() const

SignInDiscord

C++
bool SignInDiscord(int method, const std::string& externalToken)

Sign-in beyond the plain AuthorizeDiscord: method 0 browser or overlay (PKCE), 1 device code, 2 provisional account (externalToken is the game's own identity token; no Discord account needed). State: 0 signed out, 1 using the stored token, 2 refreshing, 3 waiting for the player, 4 connecting, 5 signed in, 6 failed. The token is stored in the OS credential store, never in a project file.

GetDiscordAuthState

C++
int GetDiscordAuthState() const

GetDiscordAuthFailure

C++
std::string GetDiscordAuthFailure() const

SignOutDiscord

C++
void SignOutDiscord()

SetDiscordProvisionalName

C++
void SetDiscordProvisionalName(const std::string& name)

GetDiscordRelationshipCount

C++
int GetDiscordRelationshipCount() const

Relationships. State: 0 none, 1 friend, 2 blocked, 3 incoming request, 4 outgoing request, 5 implicit (played together). Discord's own and the game's relationship are separate.

GetDiscordRelationshipIdAt

C++
uint64_t GetDiscordRelationshipIdAt(int index) const

GetDiscordRelationshipNameAt

C++
std::string GetDiscordRelationshipNameAt(int index) const

GetDiscordRelationshipStateAt

C++
int GetDiscordRelationshipStateAt(int index) const

GetDiscordGameRelationshipStateAt

C++
int GetDiscordGameRelationshipStateAt(int index) const

SendDiscordFriendRequest

C++
bool SendDiscordFriendRequest(const std::string& username)

AcceptDiscordFriendRequest

C++
bool AcceptDiscordFriendRequest(uint64_t userId)

RejectDiscordFriendRequest

C++
bool RejectDiscordFriendRequest(uint64_t userId)

CancelDiscordFriendRequest

C++
bool CancelDiscordFriendRequest(uint64_t userId)

RemoveDiscordFriend

C++
bool RemoveDiscordFriend(uint64_t userId)

BlockDiscordUser

C++
bool BlockDiscordUser(uint64_t userId)

UnblockDiscordUser

C++
bool UnblockDiscordUser(uint64_t userId)

SetDiscordActivity

C++
bool SetDiscordActivity(const std::string& details, const std::string& state, const std::string& partyId, int partySize, int partyMax, bool privateParty, const std::string& joinSecret, uint64_t startUnix, uint64_t endUnix, const std::string& buttonLabel, const std::string& buttonUrl)

Rich presence beyond details/state: party size, the join secret that puts Invite and Ask to Join on the card, timestamps, one link button. An empty partyId derives one from the join secret.

UploadLeaderboardScore

C++
bool UploadLeaderboardScore(const std::string& board, int score, bool keepBest)

Leaderboards. Upload and request are asynchronous: poll IsLeaderboardPending, then read the rows. range is 0 global, 1 around the local player, 2 friends; rows are ranked, first is 1-based.

WasLeaderboardUploadOk

C++
bool WasLeaderboardUploadOk() const

RequestLeaderboard

C++
bool RequestLeaderboard(const std::string& board, int range, int first, int count)

IsLeaderboardPending

C++
bool IsLeaderboardPending() const

GetLeaderboardCount

C++
int GetLeaderboardCount() const

GetLeaderboardRankAt

C++
int GetLeaderboardRankAt(int index) const

GetLeaderboardScoreAt

C++
int GetLeaderboardScoreAt(int index) const

GetLeaderboardNameAt

C++
std::string GetLeaderboardNameAt(int index) const

GetLeaderboardUserAt

C++
uint64_t GetLeaderboardUserAt(int index) const

AdvertiseSession

C++
void AdvertiseSession(const std::string& sessionName, int maxPlayers)

Host side of the handoff — publish the host SteamID64 + session name so a friend's Join Game resolves to a Steam P2P address.

ClearAdvertisement

C++
void ClearAdvertisement()

ConnectToHost

C++
void ConnectToHost(uint64_t hostSteamId)

Lobby → session handoff. Connects to a host over Steam P2P (feeds the SteamID64 to NetworkManager so the composite transport picks Steam, not ENet) and, when the project requires ticket auth, arms the client's encrypted-ticket send. This is the entry point a "friend clicks Join" flow lands on.

EnableSteamJoinHandling

C++
void EnableSteamJoinHandling()

Route Steam invites / friends-list "Join Game" into ConnectToHost, as the LAST resort: the session layer (FNetSession::EnableInviteHandling) takes precedence whenever a game has claimed the invite, because a bare transport connect gives the joiner no player record and no pawn.

IsSteamAvailable

C++
bool IsSteamAvailable() const

IsDiscordReady

C++
bool IsDiscordReady() const

AuthorizeDiscord

C++
bool AuthorizeDiscord()

Discord OAuth2 sign-in (PKCE, opens the overlay or a browser). Rich presence never needs it — only user-identity features do. Kick off with AuthorizeDiscord, poll IsDiscordAuthorized.

IsDiscordAuthorized

C++
bool IsDiscordAuthorized() const

AddTimelineEvent

C++
uint64_t AddTimelineEvent(const std::string& title, const std::string& description, const std::string& icon, int priority, float startOffsetSeconds, float durationSeconds, int clipPriority)

Steam Timeline: mark the moments worth clipping. icon is a Steam icon name ("steam_death", "steam_effect", "steam_attack", ...) or one uploaded on the partner site; priority orders overlapping icons (higher wins); clipPriority 0 none, 1 standard, 2 featured. durationSeconds 0 is an instant, a negative startOffsetSeconds places the event in the past (a scare that started before the scream). Returns a handle for RemoveTimelineEvent, 0 when no platform records.

RemoveTimelineEvent

C++
void RemoveTimelineEvent(uint64_t handle)

SetTimelineMode

C++
void SetTimelineMode(int mode)

0 playing, 1 staging (lobby, pre-round), 2 menus, 3 loading screen.

SetTimelineTooltip

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

ClearTimelineTooltip

C++
void ClearTimelineTooltip()

StartGamePhase

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

A round or a match, offered by the overlay as one recording.

EndGamePhase

C++
void EndGamePhase()

GetPlatformHardware

C++
std::string GetPlatformHardware() const

"none", "steam_deck", "steam_machine", "steam_frame" or "other".

GetRecommendedQualityPreset

C++
int GetRecommendedQualityPreset() const

The quality preset (EQualityPreset value) the platform recommends for this device, or -1 when it has no opinion.

IsRunningUnderProton

C++
bool IsRunningUnderProton() const
Generated from Networking/Subsystems/MPlatformSubsystem.h via networking.json · Nov 4, 2026Version 1.0.0