NetRoom
25 tools in this family (folder Editor/Tools/NetRoom/ 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 |
|---|---|---|
netroom_buddy_add | writes | Add a buddy to the current user's buddy list. Buddies survive across zones; their online/offline |
netroom_buddy_list | read-only | List the current user's buddies with online/blocked state and last-seen timestamps. |
netroom_buddy_set_variable | writes | Set a buddy variable that syncs across zones. Mark 'offline=true' to use the offline-prefix ('$') |
netroom_call_extension | writes | Invoke a server-side Java extension command via ExtensionRequest. Awaitable — the call resolves |
netroom_connect | writes | Connect the initialised SmartFox client to the configured server. Asynchronous: success or failure |
netroom_create_mmo_room | writes | Create an MMORoom with Area of Interest (AOI). The server filters which users each player sees |
netroom_create_room | writes | Create a new Room in the current zone. Supports game rooms, password-protected rooms, hidden rooms, |
netroom_disconnect | writes | Disconnect the SmartFox client. Always safe to call. Releases reflective handles and resets the runt… |
netroom_export_setup | read-only | Export the runtime configuration (host, ports, zone, transport flags, current state) as JSON. |
netroom_init | writes | Initialise the Buril SmartFoxServer 2X runtime. Builds a SmartFox client (TCP or WebSocket), |
netroom_invite_user | writes | Send an invitation to a user. The recipient receives an INVITATION event with the typed params |
netroom_join_room | writes | Join an existing Room by id or by name. Optionally pass a password and join as spectator. |
netroom_leave_room | writes | Leave the current (or specified) room. If room_id is omitted, the LastJoinedRoom is left. |
netroom_list_rooms | read-only | List visible rooms in the current zone. Optionally filter by group_id (e.g. 'games'). |
netroom_login | writes | Send a LoginRequest with username + optional password into a Zone. Custom authentication should be |
netroom_logout | writes | Logout the current user without disconnecting the socket. The client returns to the Connected state |
netroom_match_rooms | read-only | Find rooms whose RoomVariables match a chained criteria expression. Each criterion has |
netroom_send_object_message | writes | Send a typed SFSObject as an OBJECT_MESSAGE to all users in a room or to a subset of recipients. |
netroom_send_private_message | writes | Send a private (DM) message to a specific user by id. |
netroom_send_public_message | writes | Send a public chat message to all users in the current (or specified) room. Optionally attach |
netroom_set_position | writes | Set the local user's MMO position. The server publishes proximity-list deltas to neighbors as the |
netroom_set_room_variables | writes | Set per-room variables that are synced to all members. Used for game phase, shared scores, etc. |
netroom_set_user_variables | writes | Set per-user variables that are synced to all members of the current room. Used for player |
netroom_status | read-only | Read-only snapshot of the runtime: connection state, login state, my user, last joined room, last er… |
netroom_subscribe_room_group | writes | Subscribe to ROOM_ADD / ROOM_REMOVE events for the given group id. Useful for matchmaking lobbies. |