Skip to main content
This document provides a detailed reference for the public properties and methods of the PlayFlowLobbyManagerV2 class.

​
Properties

​
Instance
PlayFlowLobbyManagerV2
required
Singleton instance of the Lobby Manager. Access all lobby functionality through this.
​
IsReady
bool
required
Returns true if the manager has been successfully initialized.
​
CurrentLobby
Lobby
required
Gets the full data for the lobby the player is currently in. Returns null if not in a lobby.
​
PlayerId
string
required
Gets the unique ID of the current player, as provided during initialization.
​
State
LobbyState
required
Gets the current state of the lobby session (e.g., Disconnected, InLobby).
​
Events
PlayFlowEvents
required
Provides access to all lobby-related UnityEvents (e.g., OnLobbyJoined, OnPlayerLeft).
​
AvailableLobbies
List<Lobby>
required
A cached list of all currently available public lobbies. This list is updated automatically if auto-refresh is enabled.
​
IsInLobby
bool
required
A quick check to see if the player is currently in a lobby.
​
IsHost
bool
required
Returns true if the current player is the host of the lobby they are in.
​
InviteCode
string
required
Gets the invite code for the current private lobby. Returns null if not in a private lobby.

​
Methods

Initializes the lobby manager. This must be called before any other lobby operations.
public void Initialize(string playerId, Action onComplete = null)
​
playerId
string
required
A unique identifier for the local player.
​
onComplete
Action
An optional callback that is invoked when initialization is successful.
Creates a new lobby. There are two overloads for this method.Pass forceFresh: true to replace any lobby the local player currently hosts in this config — the backend deletes the old lobby (stopping its game server best-effort) before creating the new one. Intended for reconnect / “start a fresh session” flows, where the host may still own a stale lobby from a previous run. It’s a no-op when the player has no prior lobby.Simple:
public void CreateLobby(string name, int maxPlayers = 4, bool isPrivate = false, bool forceFresh = false, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
name
string
required
The public name of the lobby.
​
maxPlayers
int
The maximum number of players.
​
isPrivate
bool
If true, the lobby will not appear in public searches.
​
forceFresh
bool
If true, delete any lobby the local player already hosts before creating a new one. Defaults to false.
​
onSuccess
Action<Lobby>
Callback invoked with the created lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Detailed:
public void CreateLobby(string name, int maxPlayers, bool isPrivate, bool allowLateJoin, string region, Dictionary<string, object> customSettings, bool forceFresh = false, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
name
string
required
The public name of the lobby.
​
maxPlayers
int
required
The maximum number of players that can join.
​
isPrivate
bool
required
If true, the lobby will not appear in public searches.
​
allowLateJoin
bool
required
If true, players can join even after the match has started.
​
region
string
required
The server region for the lobby (e.g., “us-west”).
​
customSettings
Dictionary<string, object>
required
A dictionary of custom game-specific settings.
​
forceFresh
bool
If true, delete any lobby the local player already hosts before creating a new one. Defaults to false.
​
onSuccess
Action<Lobby>
Callback invoked with the created lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Shorthand for CreateLobby(..., forceFresh: true). The backend first deletes any lobby this player already hosts (stopping its game server best-effort), then creates a brand-new lobby atomically — replacing the old “TryReconnect → DeleteLobby → CreateLobby” dance with a single call.
public void CreateFreshLobby(string name, int maxPlayers = 4, bool isPrivate = false, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
name
string
required
The public name of the lobby.
​
maxPlayers
int
The maximum number of players. Defaults to 4.
​
isPrivate
bool
If true, the lobby will not appear in public searches.
​
onSuccess
Action<Lobby>
Callback invoked with the created lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Joins an existing lobby using its unique ID.
public void JoinLobby(string lobbyId, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
lobbyId
string
required
The unique ID (UUID) of the lobby to join.
​
onSuccess
Action<Lobby>
Callback invoked with the joined lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Joins an existing private lobby using its invite code.
public void JoinLobbyByCode(string inviteCode, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
inviteCode
string
required
The invite code of the lobby to join.
​
onSuccess
Action<Lobby>
Callback invoked with the joined lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Fetches the list of public lobbies in the project. Results are also cached on the AvailableLobbies property.
public void GetAvailableLobbies(Action<List<Lobby>> onSuccess, Action<string> onError = null)
​
onSuccess
Action<List<Lobby>>
required
Callback invoked with the list of public lobbies.
​
onError
Action<string>
Callback invoked with an error message on failure.
Leaves the lobby the player is currently in.
public void LeaveLobby(Action onSuccess = null, Action<string> onError = null)
​
onSuccess
Action
Callback invoked on successfully leaving the lobby.
​
onError
Action<string>
Callback invoked with an error message on failure.
Updates the local player’s custom state data within the lobby. This is useful for synchronizing data like character selection or ready status.
public void UpdatePlayerState(Dictionary<string, object> state, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
state
Dictionary<string, object>
required
A dictionary representing the player’s custom data.
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Kept for backward compatibility. In V3, only the target player can update their own state — if targetPlayerId isn’t the local player this call routes to UpdatePlayerState() and logs a warning. For team/role assignment, have each player set their own team via UpdatePlayerState() or push assignments through UpdateLobbySettings() (host-owned).
public void UpdateStateForPlayer(string targetPlayerId, Dictionary<string, object> state, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
targetPlayerId
string
required
The unique ID of the player whose state you want to update. Must equal the local player ID.
​
state
Dictionary<string, object>
required
A dictionary representing the new data for the target player.
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Kicks a player from the lobby. This can only be called by the host.
public void KickPlayer(string playerToKickId, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
playerToKickId
string
required
The unique ID of the player to remove from the lobby.
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Host-only. Updates lobby metadata and settings. Pass only the fields you want to change — unspecified fields are left untouched. Cannot be called while the lobby is in_game.
public void UpdateLobby(
    string name = null,
    int? maxPlayers = null,
    bool? isPrivate = null,
    bool? useInviteCode = null,
    bool? allowLateJoin = null,
    string region = null,
    Dictionary<string, object> customSettings = null,
    Action<Lobby> onSuccess = null,
    Action<string> onError = null)
​
name
string
New lobby name (3–50 characters).
​
maxPlayers
int?
New max player count (1–100).
​
isPrivate
bool?
Toggle public/private listing.
​
useInviteCode
bool?
Enable or disable invite codes.
​
allowLateJoin
bool?
Allow players to join after the match starts.
​
region
string
Region for the next game server (e.g. "us-west").
​
customSettings
Dictionary<string, object>
Replace the custom settings blob.
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Convenience shortcut for UpdateLobby(customSettings: newSettings). Host-only. Use this when you only need to update the customSettings dictionary.
public void UpdateLobbySettings(Dictionary<string, object> newSettings, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
newSettings
Dictionary<string, object>
required
New custom settings dictionary (replaces the existing one).
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Host-only. Deletes the current lobby for every player. All members are kicked and the lobby stops appearing in public searches.
public void DeleteLobby(Action onSuccess = null, Action<string> onError = null)
​
onSuccess
Action
Callback invoked once the lobby has been deleted.
​
onError
Action<string>
Callback invoked with an error message on failure.
V3 does not support explicit host transfer. Calling this method logs a warning and invokes onError. When the current host leaves, the server promotes a new host automatically — no manual transfer needed. Kept on the class for backward compatibility with V2 integrations.
public void TransferHost(string newHostId, Action<Lobby> onSuccess = null, Action<string> onError = null)
Starts the match directly, skipping matchmaking. Host-only. Launches a dedicated game server and transitions status to in_game. Use this for “Invite a friend” style lobbies; use FindMatch() for competitive queues.
public void StartMatch(Action<Lobby> onSuccess = null, Action<string> onError = null)
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.
Host-only. Rematch helper — stops the current game server, returns the lobby to waiting while keeping all players, invite code, and settings intact. Perfect for a “Play again” button. Requires lobby status in_game.If the server stops on its own (TTL, crash, clean exit), the lobby also auto-heals to waiting — no call needed.
public void EndMatch(Action<Lobby> onSuccess = null, Action<string> onError = null)
​
onSuccess
Action<Lobby>
Callback invoked with the updated lobby data on success.
​
onError
Action<string>
Callback invoked with an error message on failure.

​
Matchmaking

Host-only. Enters the lobby into the matchmaking queue for the given mode. Modes are configured per-project in the dashboard (5v5, 1v1, FFA, party sizes, skill rules, etc.).Subscribe to OnMatchmakingStarted, OnQueueStats, and OnMatchFound / OnMatchAwaitingConfirmation to drive your matchmaking UI. The lobby transitions waiting → in_queue → in_game (or match_found first, if the mode has matchConfirmation enabled).
public void FindMatch(string mode, Action<Lobby> onSuccess = null, Action<string> onError = null)
​
mode
string
required
Matchmaking mode name (must exist in dashboard config).
​
onSuccess
Action<Lobby>
Callback invoked once the lobby enters the queue.
​
onError
Action<string>
Callback invoked on validation/API error.
Host-only. Exits the matchmaking queue. Lobby returns to waiting with all players intact.
public void CancelMatchmaking(Action<Lobby> onSuccess = null, Action<string> onError = null)
​
onSuccess
Action<Lobby>
Callback invoked when back in waiting.
​
onError
Action<string>
Callback invoked with an error message on failure.
CS2-style “Accept Match”. Only relevant when the matchmaking mode has matchConfirmation.enabled: true and the lobby is in match_found status. Any player in the lobby can call this. Once every matched lobby confirms, the game server launches and status becomes in_game.Listen for OnMatchAwaitingConfirmation (match pending), OnMatchConfirmed (you/your lobby accepted), and OnMatchDeclined (someone declined or the window timed out — back to waiting).
public void ConfirmMatch(Action<Lobby> onSuccess = null, Action<string> onError = null)
​
onSuccess
Action<Lobby>
Callback invoked once the confirmation is recorded.
​
onError
Action<string>
Callback invoked with an error message on failure.
Declines a found match. Cancels the match for every participating lobby — one dissenter bails everyone. All lobbies (yours included) return to waiting; players must explicitly re-queue if they want to try again. Only valid while the lobby is in match_found.
public void DeclineMatch(Action<Lobby> onSuccess = null, Action<string> onError = null)
​
onSuccess
Action<Lobby>
Callback invoked once the decline is recorded.
​
onError
Action<string>
Callback invoked with an error message on failure.

​
Connection Info

Convenience helper that returns the first port as a simple { Ip, Port } tuple. Good for single-port games; for anything else use the named lookups below.
public ConnectionInfo? GetGameServerConnectionInfo()
Returns: A ConnectionInfo struct with Ip and Port of the first network_ports entry, or null if no server is running.