Package sfs3.client.requests

Class ChangeRoomCapacityRequest

java.lang.Object

sfs3.client.requests.BaseRequest

sfs3.client.requests.ChangeRoomCapacityRequest

All Implemented Interfaces:

sfs3.client.requests.IClientRequest

public class ChangeRoomCapacityRequest
extends BaseRequest

Changes the maximum number of users and/or spectators who can join a Room.

If the operation is successful, the roomCapacityChange event is dispatched to all the users who subscribed the Group to which the target Room belongs, including the requester user himself. If the user is not the creator (owner) of the Room the roomCapacityChangeError event is fired. An administrator or moderator can override this constraint (he is not requested to be the Room's owner).

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.

If the Room was configured so that resizing is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

Also note that some restrictions are applied to the passed values (i.e. a client can't set the max users to more than 200, or the max spectators to more than 32).

See Also:

• SFSEvent.ROOM_CAPACITY_CHANGE
• SFSEvent.ROOM_CAPACITY_CHANGE_ERROR
• RoomSettings.getPermissions()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_ROOM
static final String	KEY_SPEC_SIZE
static final String	KEY_USER_SIZE

Fields inherited from class sfs3.client.requests.BaseRequest

AddBuddy, AdminMessage, AutoJoin, BanUser, BanUsersFromRoom, BlockBuddy, CallExtension, ChangeRoomCapacity, ChangeRoomName, ChangeRoomPassword, ClusterInviteUsers, ClusterJoinOrCreate, CreateRoom, CreateSFSGame, FindRooms, FindUsers, GameServerConnectionRequired, GenericMessage, GetRoomList, GoOnline, Handshake, InitBuddyList, InvitationReply, InviteUser, JoinRoom, JoinRoomInvite, KEY_ERROR_CODE, KEY_ERROR_PARAMS, KickUser, LeaveRoom, Login, Logout, ManualDisconnection, ModeratorMessage, ObjectMessage, PingPong, PlayerToSpectator, PrivateMessage, PublicMessage, QuickJoinGame, QuickJoinOrCreateRoom, RemoveBuddy, SetBuddyVariables, SetRoomVariables, SetUserPosition, SetUserVariables, sfso, SpectatorToPlayer, SubscribeRoomGroup, targetController, UdpInit, UnsubscribeRoomGroup

Constructor Summary

Constructors

Constructor	Description
ChangeRoomCapacityRequest(Room room, int newMaxUsers, int newMaxSpect)	Creates a new ChangeRoomCapacityRequest instance.

Method Summary

Modifier and Type	Method	Description
void	execute(ISmartFox sfs)
void	validate(ISmartFox sfs)

Methods inherited from class sfs3.client.requests.BaseRequest

getId, getRequest, getTargetController, getTransportType, setId, setTargetController, setTransportType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

KEY_ROOM

public static final String KEY_ROOM

See Also:

• Constant Field Values

Internal

KEY_USER_SIZE

public static final String KEY_USER_SIZE

See Also:

• Constant Field Values

Internal

KEY_SPEC_SIZE

public static final String KEY_SPEC_SIZE

See Also:

• Constant Field Values

Internal

Constructor Details

ChangeRoomCapacityRequest

public ChangeRoomCapacityRequest(Room room,
 int newMaxUsers,
 int newMaxSpect)

Creates a new ChangeRoomCapacityRequest instance. The instance must be passed to the SmartFox.send() method for the request to be performed.

Parameters:

room - The Room object corresponding to the Room whose capacity should be changed.

newMaxUsers - The new maximum number of users/players who can join the Room;

newMaxSpect - The new maximum number of spectators who can join the Room (for Game Rooms only);

See Also:

• SmartFox.send(sfs3.client.requests.IClientRequest)
• Room.getMaxUsers()

Method Details

validate

public void validate(ISmartFox sfs)
              throws SFSValidationException

Throws:

SFSValidationException

Internal

execute

public void execute(ISmartFox sfs)

Internal