UgsRelay
14 tools in this family (folder Editor/Tools/UgsRelay/ 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_relay_bind_to_fusion | writes | Wire a Relay allocation into a Photon Fusion adapter component (FusionUgsRelayAdapter). Fusion |
ugs_relay_bind_to_mirror | writes | Wire a Relay allocation into Mirror's UnityRelayTransport (or MirrorRelayTransport) component |
ugs_relay_bind_to_ngo | writes | Wire a Relay allocation into the NGO UnityTransport in the active scene. Reflectively calls |
ugs_relay_bind_to_transport | writes | Generic transport binder — pokes well-known fields (joinCode/allocationId/region/connectionData/key)… |
ugs_relay_create_allocation | writes | Create a host-side Relay allocation. Returns the allocation_id and the list of server endpoints |
ugs_relay_delete_allocation | writes | Delete a Relay allocation, releasing the slot on Unity's edge servers. Call this when the |
ugs_relay_export_setup | read-only | Export the current Relay configuration as a JSON snapshot — package availability, list of active |
ugs_relay_format_connection_data | read-only | Format an allocation as the byte[] Unity Transport expects when wiring a Relay session. Choose |
ugs_relay_get_active_allocations | read-only | List the allocations currently tracked by Buril's Relay runtime — those produced by |
ugs_relay_get_join_code | writes | Get the 6-character join code for an allocation. Hosts publish this code (e.g. on-screen, via |
ugs_relay_init | writes | Verify that Unity Gaming Services Authentication is initialized and signed in — Relay sits on |
ugs_relay_join_allocation | writes | Client-side: join a Relay allocation using the 6-character code published by the host. Returns |
ugs_relay_list_regions | read-only | List all Relay regions available to the current UGS environment. Each region has an id (e.g. |
ugs_relay_send_heartbeat | writes | Stamp the allocation's last_heartbeat to keep it logically alive. UGS Relay's allocations stay |