Ali Şahan Yalçın
DocsFinding lobbies

Lobbies

Finding lobbies

Search for lobbies and filter the results down to the ones you want.

The node

Use Find Lobbies (Async). It takes a Steam Lobby Search Query and returns an array of results.

Each result already carries what a browser needs: the lobby ID, how many players are in it, the member limit, the owner, and every key the host published. You do not need a follow up call per lobby.

Result fieldMeaning
Lobby IdPass this to Join Lobby
Member CountPlayers currently inside
Member LimitMaximum players
OwnerThe host's Steam ID
MetadataEvery key and value the host published

Building the query

Fill in a Steam Lobby Search Query struct:

FieldWhat it does
String FiltersMatch a published key against text
Numeric FiltersMatch a published key against a number
Near Value FiltersSort results by closeness to a number, rather than excluding any
Minimum Free SlotsOnly lobbies with at least this many open slots
DistanceHow far to search geographically
Max ResultsCap on results, 1 to 50

String filters

Each entry has a Key, a Value, and a Comparison. To find only lobbies running your game mode:

  • Key: mode
  • Value: deathmatch
  • Comparison: Equal
  • This only matches lobbies where the host called Set Lobby Data with key mode and value deathmatch.

    Numeric filters

    Same shape, with an integer value and comparisons like Equal, Not Equal, Greater Than and Less Than. Useful for a published skill rating or map size.

    Near value filters

    These do not remove anything. They sort. A near value filter on skill with target 1200 puts lobbies closest to 1200 first, without hiding the rest.

    Distance

    ValueMeaning
    CloseSame immediate region only
    DefaultSame continent
    FarNearby continents
    WorldwideEverywhere. Highest ping, most results.

    A minimal search flow

  • Make a Steam Lobby Search Query, set Max Results to 20.
  • Call Find Lobbies (Async).
  • On On Success, loop the results array and create one row widget per entry.
  • Read the name out of Metadata with a Map Find on your name key.
  • No results is not an error

    An empty array with a successful result means the search worked and nothing matched. That is the normal state when you are the first person online.

    Before assuming something is broken, check:

  • Are you and the other player using the same App ID?
  • Is the lobby Public? Friends Only and Private lobbies never appear in searches.
  • Are your filters excluding it? Remove all filters and search again.
  • Is the lobby full? A full lobby is excluded automatically.
  • WARNING: Two Play In Editor clients share one Steam account, so searching from one and hosting from the other will not behave the way two real players would. Set Mock Mode to Always for local multiplayer testing, or run two Standalone Game instances.

    Where to go next

    Joining a lobby.