ChangeRoomCapacityRequest

Changes the maximum number of Users and/or Spectators allowed to join a Room.

If the operation is successful, the SFSEvent.ROOM_CAPACITY_CHANGE event is dispatched to all the Users which subscribed the Group to which the target Room belongs, including the requester User itself. If the User is not the creator (owner) of the Room, the SFSEvent.ROOM_CAPACITY_CHANGE_ERROR event is fired. An administrator or moderator can override this constrain (doesn't need to be the Room's owner).

Note that some limitations are applied to the passed values; for example a client cannot set the max Users to more than 200, or the max Spectators to more than 32. Also, if the Room is configured so that resizing is not allowed (see the RoomSettings#permissions parameter), the request is ignored and no error is fired.

In case the Room's capacity is reduced to a value less than the current number of Users/Spectators inside the Room, exceeding users are NOT disconnected.

Constructor

new ChangeRoomCapacityRequest(room, newMaxUsers, newMaxSpect)

Creates a new instance of the ChangeRoomCapacityRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.
Parameters:
NameTypeDescription
roomSFSRoomThe object representing the Room whose capacity should be changed.
newMaxUsersnumberThe new maximum number of Users/Players allowed to join the Room.
newMaxSpectnumberThe new maximum number of Spectators allowed to join the Room (Game Rooms only).
See
Fires: