UgsMatchmaking
22 tools in this family (folder Editor/Tools/UgsMatchmaking/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.
| Tool | Effect | Description |
|---|---|---|
ugs_matchmaking_create_lobby_with_relay | writes | Host-side combined flow: create a Lobby AND a Relay allocation, then write the Relay join code into |
ugs_matchmaking_create_ticket | writes | Create a Matchmaker ticket and submit it to a queue. A ticket can carry one player (solo) or |
ugs_matchmaking_delete_ticket | writes | Cancel a Matchmaker ticket. The ticket is removed from the queue and its status becomes 'cancelled'.… |
ugs_matchmaking_export_setup | read-only | Export the current Lobby + Matchmaker configuration as a JSON snapshot: package availability, |
ugs_matchmaking_get_ticket_status | read-only | Get a Matchmaker ticket's current status: queued | matched | cancelled | error. When matched, the… |
ugs_matchmaking_join_lobby_via_relay | writes | Client-side combined flow: join a Lobby (by lobby_id or join_code) → read 'relay_join_code' from the… |
ugs_matchmaking_lobby_create | writes | Create a UGS Lobby. The caller becomes the host. Lobby has a 6-character join_code clients can use |
ugs_matchmaking_lobby_delete | writes | Host-only: delete a Lobby. All remaining members receive a KickedFromLobby callback (if subscribed).… |
ugs_matchmaking_lobby_heartbeat | writes | Host-only: send a heartbeat ping to keep a Lobby alive. UGS reaps lobbies that go ~30s without a |
ugs_matchmaking_lobby_join_by_code | writes | Join a Lobby by its 6-character human-readable join_code (the code returned by Create). Codes are |
ugs_matchmaking_lobby_join_by_id | writes | Join a specific Lobby by its id. Use this when you know the lobby_id (e.g. shared via friends API |
ugs_matchmaking_lobby_leave | writes | Leave a Lobby. If the leaving player is the host AND there are other members, UGS auto-reassigns |
ugs_matchmaking_lobby_query | read-only | List public, joinable lobbies. Returns up to max_results (default 25). Lobbies marked is_private |
ugs_matchmaking_lobby_quick_join | writes | Quick-join: ask UGS to pick the first public lobby that matches the optional filter. Useful for |
ugs_matchmaking_lobby_remove_player | writes | Host-only: kick a player from a Lobby. Same UGS endpoint as Leave on the back end; Buril distinguish… |
ugs_matchmaking_lobby_subscribe | writes | Subscribe to LobbyChanged / KickedFromLobby / LobbyEventConnectionStateChanged callbacks. Returns a |
ugs_matchmaking_lobby_update | writes | Update Lobby properties (name, is_locked, is_private, max_players, host_id) and/or its data entries.… |
ugs_matchmaking_lobby_update_player | writes | Set or merge per-player data on a player in a Lobby. Use for ready states, character selection, etc.… |
ugs_matchmaking_matchmake_and_join | writes | High-level flow: create a ticket → poll until matched → join the assigned Lobby — in one call. |
ugs_matchmaking_poll_until_match | writes | Poll a ticket until it reaches 'matched' or max_seconds elapses. Returns the Assignment on success. |
ugs_matchmaking_register_backfill | writes | Register that a Lobby has open slots and should accept Matchmaker fills. The Matchmaker queue |
ugs_matchmaking_remove_backfill | writes | Stop accepting Matchmaker fills for a Lobby. Call this once the desired number of players has |