UgsMultiplay
16 tools in this family (folder Editor/Tools/UgsMultiplay/ 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_multiplay_begin_shutdown | writes | Begin a graceful shutdown: (1) Unready so no new players are assigned, (2) invoke the registered |
ugs_multiplay_export_setup | read-only | Export the current Multiplay state as a JSON snapshot: package availability, server config, state |
ugs_multiplay_get_fleet_status | read-only | Live fleet telemetry: running / allocated / ready / pending server counts, the queue depth feeding |
ugs_multiplay_get_server_config | read-only | Return the current ServerConfig — allocation id, server id, build configuration id, map, game type, |
ugs_multiplay_init | writes | Verify that Unity Gaming Services Authentication is initialized — Multiplay sits on top of Auth, |
ugs_multiplay_list_builds | read-only | List server builds uploaded to the Multiplay dashboard (id, name, version, OS, architecture, size, |
ugs_multiplay_list_fleets | read-only | List active fleets — id, name, scaling mode, regions, feeding queue, min/max server counts. A fleet |
ugs_multiplay_player_joined | writes | Report that a player has joined the running match. Informational — Multiplay uses this for billing |
ugs_multiplay_player_left | writes | Report that a player has left the running match. Informational — Multiplay uses this for billing. |
ugs_multiplay_ready_for_players | writes | Flip the server into 'ready' state — the Multiplay backend now considers this server eligible for |
ugs_multiplay_register_backfill | writes | Server-initiated backfill: tell Matchmaker the running match has open_slots open and to keep filling… |
ugs_multiplay_register_shutdown_handler | writes | Register a Buril-side shutdown handler that fires when ugs_multiplay_begin_shutdown is called. In th… |
ugs_multiplay_remove_backfill | writes | Stop accepting Matchmaker fills for the current allocation. Call this when the desired number of |
ugs_multiplay_start_query_handler | writes | Open the SQP (Server Query Protocol) / A2S query port so the Multiplay backend can probe this server… |
ugs_multiplay_subscribe_events | writes | Register a callback set on Buril's event router for Allocate / Deallocate / Error. Returns a |
ugs_multiplay_unready | writes | Refuse new player allocations without shutting the server down. Use this when a match is in progress… |