class

IArcLobbySource

What the lobby screen reads and drives. ArcUI sits below the networking session in nothing it may include, so the host that owns both — the game player — implements this over FNetSession and the platform's lobby list and installs it (AArcUILobbyScreen::SetSourceFactory). A test drives the screen through a fake one. Every call is safe to make in any state.

Module
ArcUI
Header
#include "ArcUI/Lobby/IArcLobbySource.h"
Namespace
Mowo

Constructors

SignatureNameDescription
virtual ~IArcLobbySource() = default~IArcLobbySource

Public functions

ReturnsNameDescription
EArcLobbySessionStateGetSessionState
boolIsHost
int32_tGetPhase0 = lobby (the hub between runs), 1 = in a run.
std::vector<FArcLobbyPlayer>GetPlayers
std::stringGetSessionName
std::stringGetJoinKeyThe key a player on another machine needs to join this hosted session directly; empty when there is none to show.
int32_tGetMaxPlayers
boolSetReady
boolStartRun
boolReturnToLobby
voidLeaveSession
std::stringGetLastExitReasonWhy the last session ended, for the banner over the browser.
boolCanBrowseThe browser.
voidRefreshServers
boolIsRefreshing
std::vector<FArcLobbyServer>GetServers
boolJoinServer
boolJoinAddressjoinKey: the host's key for a direct join from another machine, typed after the address as host:port#KEY; empty without one.
boolHostSession

Function details

~IArcLobbySource

C++
virtual ~IArcLobbySource() = default

GetSessionState

C++
virtual EArcLobbySessionState GetSessionState() const = 0

IsHost

C++
virtual bool IsHost() const = 0

GetPhase

C++
virtual int32_t GetPhase() const = 0

0 = lobby (the hub between runs), 1 = in a run.

GetPlayers

C++
virtual std::vector<FArcLobbyPlayer> GetPlayers() const = 0

GetSessionName

C++
virtual std::string GetSessionName() const = 0

GetJoinKey

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

The key a player on another machine needs to join this hosted session directly; empty when there is none to show.

GetMaxPlayers

C++
virtual int32_t GetMaxPlayers() const = 0

SetReady

C++
virtual bool SetReady(bool ready) = 0

StartRun

C++
virtual bool StartRun(bool force) = 0

ReturnToLobby

C++
virtual bool ReturnToLobby() = 0

LeaveSession

C++
virtual void LeaveSession() = 0

GetLastExitReason

C++
virtual std::string GetLastExitReason() const = 0

Why the last session ended, for the banner over the browser.

CanBrowse

C++
virtual bool CanBrowse() const = 0

The browser. CanBrowse is false where no platform lists sessions (no Steam); the screen then offers only Host and Direct Connect.

RefreshServers

C++
virtual void RefreshServers() = 0

IsRefreshing

C++
virtual bool IsRefreshing() const = 0

GetServers

C++
virtual std::vector<FArcLobbyServer> GetServers() const = 0

JoinServer

C++
virtual bool JoinServer(const FArcLobbyServer& server) = 0

JoinAddress

C++
virtual bool JoinAddress(const std::string& host, uint16_t port, const std::string& joinKey) = 0

joinKey: the host's key for a direct join from another machine, typed after the address as host:port#KEY; empty without one.

HostSession

C++
virtual bool HostSession() = 0
Generated from ArcUI/Lobby/IArcLobbySource.h via arcui.json · Nov 4, 2026Version 1.0.0