Room Interface |
The Room interface defines all the methods and properties that an object representing a SmartFoxServer Room entity exposes.
Namespace: Sfs2X.Entities
Assembly: SmartFox2X (in SmartFox2X.dll) Version: 1.8.0.0 (1.8.0)
SyntaxC#
public interface Room
The Room 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.
|
| RoomManager |
Returns a reference to the Room Manager which manages this Room.
|
| 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.
|
Remarks
In the SmartFoxServer 2X client API this interface is implemented by the SFSRoom class. Read the class description for additional informations.
See Also