_server.leaveRoom()

Availability:

SmartFoxServer PRO 1.4.0

Usage:

_server.leaveRoom(user, roomId, broadcastAll)

Description:

Force a user to leave a room. This command is the equivalent of the leaveRoom() method on the client side. It can be user when working in "multi-room" mode.

Properties:

user   the user that should leave the room
roomId   the id of the room to leaver
broadcastAll   (optional) boolean flag. If true the onRoomLeft() event will be fired. By default it is set to true

Returns:

Nothing

Example:

// Force a user to leave a room
_server.leaveRoom(theUserObj, theRoomId)

See also: