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
| Signature | Name | Description |
|---|---|---|
virtual ~IArcLobbySource() = default | ~IArcLobbySource |
Public functions
| Returns | Name | Description |
|---|---|---|
EArcLobbySessionState | GetSessionState | |
bool | IsHost | |
int32_t | GetPhase | 0 = lobby (the hub between runs), 1 = in a run. |
std::vector<FArcLobbyPlayer> | GetPlayers | |
std::string | GetSessionName | |
std::string | GetJoinKey | The key a player on another machine needs to join this hosted session directly; empty when there is none to show. |
int32_t | GetMaxPlayers | |
bool | SetReady | |
bool | StartRun | |
bool | ReturnToLobby | |
void | LeaveSession | |
std::string | GetLastExitReason | Why the last session ended, for the banner over the browser. |
bool | CanBrowse | The browser. |
void | RefreshServers | |
bool | IsRefreshing | |
std::vector<FArcLobbyServer> | GetServers | |
bool | JoinServer | |
bool | JoinAddress | joinKey: the host's key for a direct join from another machine, typed after the address as host:port#KEY; empty without one. |
bool | HostSession |
Function details
~IArcLobbySource
virtual ~IArcLobbySource() = defaultGetSessionState
virtual EArcLobbySessionState GetSessionState() const = 0IsHost
virtual bool IsHost() const = 0GetPhase
virtual int32_t GetPhase() const = 00 = lobby (the hub between runs), 1 = in a run.
GetPlayers
virtual std::vector<FArcLobbyPlayer> GetPlayers() const = 0GetSessionName
virtual std::string GetSessionName() const = 0GetJoinKey
virtual std::string GetJoinKey() constThe key a player on another machine needs to join this hosted session directly; empty when there is none to show.
GetMaxPlayers
virtual int32_t GetMaxPlayers() const = 0SetReady
virtual bool SetReady(bool ready) = 0StartRun
virtual bool StartRun(bool force) = 0ReturnToLobby
virtual bool ReturnToLobby() = 0LeaveSession
virtual void LeaveSession() = 0GetLastExitReason
virtual std::string GetLastExitReason() const = 0Why the last session ended, for the banner over the browser.
CanBrowse
virtual bool CanBrowse() const = 0The browser. CanBrowse is false where no platform lists sessions (no Steam); the screen then offers only Host and Direct Connect.
RefreshServers
virtual void RefreshServers() = 0IsRefreshing
virtual bool IsRefreshing() const = 0GetServers
virtual std::vector<FArcLobbyServer> GetServers() const = 0JoinServer
virtual bool JoinServer(const FArcLobbyServer& server) = 0JoinAddress
virtual bool JoinAddress(const std::string& host, uint16_t port, const std::string& joinKey) = 0joinKey: the host's key for a direct join from another machine, typed after the address as host:port#KEY; empty without one.
HostSession
virtual bool HostSession() = 0