Skip to main content

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.

ToolEffectDescription
netroom_buddy_addwritesAdd a buddy to the current user's buddy list. Buddies survive across zones; their online/offline
netroom_buddy_listread-onlyList the current user's buddies with online/blocked state and last-seen timestamps.
netroom_buddy_set_variablewritesSet a buddy variable that syncs across zones. Mark 'offline=true' to use the offline-prefix ('$')
netroom_call_extensionwritesInvoke a server-side Java extension command via ExtensionRequest. Awaitable — the call resolves
netroom_connectwritesConnect the initialised SmartFox client to the configured server. Asynchronous: success or failure
netroom_create_mmo_roomwritesCreate an MMORoom with Area of Interest (AOI). The server filters which users each player sees
netroom_create_roomwritesCreate a new Room in the current zone. Supports game rooms, password-protected rooms, hidden rooms,
netroom_disconnectwritesDisconnect the SmartFox client. Always safe to call. Releases reflective handles and resets the runt…
netroom_export_setupread-onlyExport the runtime configuration (host, ports, zone, transport flags, current state) as JSON.
netroom_initwritesInitialise the Buril SmartFoxServer 2X runtime. Builds a SmartFox client (TCP or WebSocket),
netroom_invite_userwritesSend an invitation to a user. The recipient receives an INVITATION event with the typed params
netroom_join_roomwritesJoin an existing Room by id or by name. Optionally pass a password and join as spectator.
netroom_leave_roomwritesLeave the current (or specified) room. If room_id is omitted, the LastJoinedRoom is left.
netroom_list_roomsread-onlyList visible rooms in the current zone. Optionally filter by group_id (e.g. 'games').
netroom_loginwritesSend a LoginRequest with username + optional password into a Zone. Custom authentication should be
netroom_logoutwritesLogout the current user without disconnecting the socket. The client returns to the Connected state
netroom_match_roomsread-onlyFind rooms whose RoomVariables match a chained criteria expression. Each criterion has
netroom_send_object_messagewritesSend a typed SFSObject as an OBJECT_MESSAGE to all users in a room or to a subset of recipients.
netroom_send_private_messagewritesSend a private (DM) message to a specific user by id.
netroom_send_public_messagewritesSend a public chat message to all users in the current (or specified) room. Optionally attach
netroom_set_positionwritesSet the local user's MMO position. The server publishes proximity-list deltas to neighbors as the
netroom_set_room_variableswritesSet per-room variables that are synced to all members. Used for game phase, shared scores, etc.
netroom_set_user_variableswritesSet per-user variables that are synced to all members of the current room. Used for player
netroom_statusread-onlyRead-only snapshot of the runtime: connection state, login state, my user, last joined room, last er…
netroom_subscribe_room_groupwritesSubscribe to ROOM_ADD / ROOM_REMOVE events for the given group id. Useful for matchmaking lobbies.