Skip to main content

NgoNetwork

30 tools in this family (folder Editor/Tools/NgoNetwork/ 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
get_ngo_network_manager_configread-only[Alias of ngo_get_config] Return the NetworkManager singleton's config including tick rate,
list_ngo_network_objects_in_sceneread-only[Alias of ngo_list_network_objects] List every NetworkObject in the active scene, including
list_ngo_network_prefabsread-onlyList all prefabs registered as network-spawnable: those in NetworkConfig.Prefabs (real mode)
ngo_configure_connection_approvalwritesEnable NGO's ConnectionApproval flow. Registers a callback that compares the connection
ngo_despawnwritesDespawn a NetworkObject by net_id. Removes it from all clients and frees its network id.
ngo_export_setupread-onlyExport the current NGO runtime configuration (transport, role flags, registered prefabs,
ngo_generate_network_behaviourwritesEmit a NGO-compatible NetworkBehaviour C# class with NetworkVariables, NetworkLists, ServerRpcs,
ngo_get_configread-onlyGet the NetworkManager singleton's config: tick rate, transport name, scene management flag,
ngo_hook_ugs_lobbywritesWire the Buril NGO runtime to a UGS Lobby by id. Lobbies are the canonical UGS object for
ngo_hook_ugs_matchmakerwritesSubmit a Matchmaker ticket against the configured queue. Properties is a flat key→value map
ngo_hook_ugs_relaywritesWire the Buril NGO runtime to a UGS Relay allocation by join code. NAT-punchthrough for any
ngo_initwritesInitialise the Buril NGO runtime. Configures transport (UnityTransport / Relay / WSS / Custom),
ngo_list_network_objectsread-onlyList every NetworkObject in the active scene, including inactive ones. Returns network_id (0 if
ngo_load_scene_syncwritesLoad a scene through NetworkSceneManager so all connected clients load it together. Optionally
ngo_migrate_authoritywritesTransfer authority of a NetworkObject to a different client. In classic server-auth this is
ngo_register_prefabwritesRegister a prefab as spawnable by ngo_spawn. The asset must have a NetworkObject component.
ngo_send_named_messagewritesSend a named custom message (CustomMessagingManager). Targets a specific client by id, or all
ngo_set_transportwritesSwitch the active transport. Common values: unity_transport (UDP), relay (UGS Relay), wss
ngo_setup_network_animatorwritesAdd a NetworkAnimator component to a GameObject that already has an Animator. Animator parameters
ngo_setup_network_rigidbodywritesAdd a NetworkRigidbody component for physics sync. Pass use_rigidbody2d=true for 2D physics
ngo_setup_network_transformwritesAdd a NetworkTransform component to a GameObject (asset prefab or scene object). Configures sync
ngo_shutdownwritesStop NGO entirely. Calls NetworkManager.Shutdown(true), resets the mock broker, and clears the
ngo_simulate_networkwritesApply latency / packet-loss / jitter simulation on the active transport. In real mode this
ngo_spawnwritesSpawn a registered prefab on the network. Modes:\n
ngo_start_clientwritesStart NGO as client and connect to the configured server. Requires ngo_init beforehand.
ngo_start_distributed_authoritywritesStart NGO 2.0 in Distributed Authority mode. No host; each client owns the objects it spawned
ngo_start_hostwritesStart NGO as host (server + local client in one process). Requires ngo_init beforehand.
ngo_start_serverwritesStart NGO as dedicated server (no local client). Requires ngo_init beforehand.
ngo_start_sessionwrites[Compat alias] Start an NGO session in one of the classic roles. Equivalent to calling
ngo_statusread-onlyQuery the current NGO runtime state — initialised, mock vs real, role flags, connected client