ClusterRoomSettings Class |
The ClusterRoomSettings class is a container for the settings required to create a Game Room on a Game Node in a SmartFoxServer 2X Cluster.
Inheritance HierarchyNamespace: Sfs2X.Requests.Cluster
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class ClusterRoomSettings : RoomSettings
The ClusterRoomSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClusterRoomSettings |
Creates a new ClusterRoomSettings instance.
|
Properties| Name | Description | |
|---|---|---|
 | AllowOwnerOnlyInvitation |
Specifies if the Room allows "Join Room" invitations to be sent by any user or just by its owner.
(Inherited from RoomSettings.) |
| Events |
Defines the flags indicating which events related to the Room are dispatched by the SmartFox client.
(Inherited from RoomSettings.) |
| Extension |
Defines the Extension that must be attached to the Room on the server-side, and its settings.
(Inherited from RoomSettings.) |
| GroupId |
Defines the id of the Group to which the Room should belong.
(Inherited from RoomSettings.) |
| InvitationExpiryTime |
In private games, defines the number of seconds that the users invited to join the game have to reply to the invitation.
|
| InvitationParams |
In private games, defines an optional object containing additional custom parameters to be sent together with the invitation.
|
| InvitedPlayers |
In private games, defines a list of Buddy or User objects representing players to be invited to join the game.
|
| IsGame |
Indicates whether the Room is a Game Room or not.
(Inherited from RoomSettings.) |
| IsPublic |
Indicates whether the game is public or private.
|
| MaxSpectators |
Defines the maximum number of spectators allowed in the Room (only for Game Rooms).
(Inherited from RoomSettings.) |
| MaxUsers |
Defines the maximum number of users allowed in the Room.
(Inherited from RoomSettings.) |
| MaxVariables |
Defines the maximum number of Room Variables allowed for the Room.
(Inherited from RoomSettings.) |
| MinPlayersToStartGame |
Defines the minimum number of players required to start the game.
|
| Name |
Defines the name of the Room.
(Inherited from RoomSettings.) |
| NotifyGameStarted |
Indicates if a game state change must be notified when the minimum number of players is reached.
|
| Password |
Defines the password of the Room.
(Inherited from RoomSettings.) |
| Permissions |
Defines the flags indicating which operations are permitted on the Room.
(Inherited from RoomSettings.) |
| Variables |
Defines a list of RooomVariable objects to be attached to the Room.
(Inherited from RoomSettings.) |
Remarks
On the server-side, a Game Room is represented on the Game Node by the SFSGame Java class which extends the Room class providing advanced features such as player matching,
game invitations, public and private games, quick game joining, etc. On the client side Game Rooms are regular Rooms with their Room.IsGame property set to true.
See Also