Skip to main content

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.

ToolEffectDescription
ugs_relay_bind_to_fusionwritesWire a Relay allocation into a Photon Fusion adapter component (FusionUgsRelayAdapter). Fusion
ugs_relay_bind_to_mirrorwritesWire a Relay allocation into Mirror's UnityRelayTransport (or MirrorRelayTransport) component
ugs_relay_bind_to_ngowritesWire a Relay allocation into the NGO UnityTransport in the active scene. Reflectively calls
ugs_relay_bind_to_transportwritesGeneric transport binder — pokes well-known fields (joinCode/allocationId/region/connectionData/key)…
ugs_relay_create_allocationwritesCreate a host-side Relay allocation. Returns the allocation_id and the list of server endpoints
ugs_relay_delete_allocationwritesDelete a Relay allocation, releasing the slot on Unity's edge servers. Call this when the
ugs_relay_export_setupread-onlyExport the current Relay configuration as a JSON snapshot — package availability, list of active
ugs_relay_format_connection_dataread-onlyFormat an allocation as the byte[] Unity Transport expects when wiring a Relay session. Choose
ugs_relay_get_active_allocationsread-onlyList the allocations currently tracked by Buril's Relay runtime — those produced by
ugs_relay_get_join_codewritesGet the 6-character join code for an allocation. Hosts publish this code (e.g. on-screen, via
ugs_relay_initwritesVerify that Unity Gaming Services Authentication is initialized and signed in — Relay sits on
ugs_relay_join_allocationwritesClient-side: join a Relay allocation using the 6-character code published by the host. Returns
ugs_relay_list_regionsread-onlyList all Relay regions available to the current UGS environment. Each region has an id (e.g.
ugs_relay_send_heartbeatwritesStamp the allocation's last_heartbeat to keep it logically alive. UGS Relay's allocations stay