SFSRoom Class |
The SFSRoom object represents a SmartFoxServer Room entity on the client.
Inheritance HierarchyNamespace: Sfs2X.Entities
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public class SFSRoom : Room
The SFSRoom type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Capacity |
Returns the maximum amount of users, including spectators, that can be contained in this Room.
|
| GroupId |
Returns the Room Group name.
|
| Id |
Indicates the id of this Room.
|
| IsGame |
Indicates whether this is a Game Room or not.
|
| IsHidden |
Indicates whether this Room is hidden or not.
|
| IsJoined |
Indicates whether the client joined this Room or not.
|
| IsPasswordProtected |
Indicates whether this Room requires a password to be joined or not.
|
| MaxSpectators |
Returns the maximum number of spectators allowed in this Room (Game Rooms only).
|
| MaxUsers |
Returns the maximum number of users allowed in this Room.
|
| Name |
Indicates the name of this Room.
|
| PlayerList |
Returns a list of User objects representing the players currently inside this Room (Game Rooms only).
|
| Properties |
Defines a generic utility object that can be used to store custom Room data.
|
| SpectatorCount |
Returns the current number of spectators in this Room (Game Rooms only).
|
| SpectatorList |
Returns a list of User objects representing the spectators currently inside this Room (Game Rooms only).
|
| UserCount |
Returns the current number of users in this Room.
|
| UserList |
Returns a list of User objects representing all the users currently inside this Room.
|
Methods| Name | Description | |
|---|---|---|
 | ContainsUser |
Indicates whether the specified user is currently inside this Room or not.
|
| ContainsVariable |
Indicates whether this Room has the specified Room Variable set or not.
|
| GetUserById |
Retrieves a User object from its id property.
|
| GetUserByName |
Retrieves a User object from its name property.
|
| GetVariable |
Retrieves a Room Variable from its name.
|
| GetVariables |
Retrieves all the Room Variables of this Room.
|
| ToString |
Returns a string that contains the Room id, name and id of the Group to which it belongs.
(Overrides ObjectToString.) |
Remarks
The SmartFoxServer 2X client API are not aware of all the Rooms which exist on the server side, but only of those that are joined by the user
and those in the Room Groups that have been subscribed. Subscribing to one or more Groups allows the client to listen to Room events in specific "areas" of the Zone,
without having to retrieve and keep synchronized the details of all available Rooms, thus reducing the traffic between the client and the server considerably.
The list of available Rooms is created after a successful login and it is kept updated continuously by the server.
See Also