Modules
Multiplayer
Lobbies

Lobbies

Overview Config Scripts

Errors

Dependencies

Public Scripts

Scripts that are accessible to game clients and can be called directly via the generated SDK endpoints.

Create Lobby`create`

Creates a new lobby on-demand.

Destroy Lobby`destroy`

Destroys an existing lobby.

Find Or Create Lobby`find_or_create`

Finds a lobby or creates one if there are no available spots for players.

Join Lobby`join`

Add a player to an existing lobby.

List Lobbies`list`

List & query all lobbies.

Set Lobby Ready`set_lobby_ready`

Called on lobby startup after initiation to notify it can start accepting player. This should be called after operations like loading maps are complete.

Set Player Connected`set_player_connected`

Called when a player connects to the lobby.

Set Player Disconnected`set_player_disconnected`

Called when a player disconnects from the lobby.

Find Lobby`find`

Finds an existing lobby with a given query. This will not create a new lobby, see find_or_create instead.

Fetch Lobby Manager State`fetch_lobby_manager_state`

See full state of the lobby manager for debugging.

Reset Lobby Manager State`reset_lobby_manager_state`

Reset lobby manager state. For debugging only.

Private Scripts

Scripts that are only accessible within the backend and cannot be called directly by game clients.

Force Garbage Collection`force_gc`

Rarely used. Forces the matchmaker to purge lobbies & players.

List Regions`list_regions`

List available regions.

Lobbies

Public Scripts

Create Lobbycreate

Destroy Lobbydestroy

Find Or Create Lobbyfind_or_create

Join Lobbyjoin

List Lobbieslist

Set Lobby Readyset_lobby_ready

Set Player Connectedset_player_connected

Set Player Disconnectedset_player_disconnected

Find Lobbyfind

Fetch Lobby Manager Statefetch_lobby_manager_state

Reset Lobby Manager Statereset_lobby_manager_state