SFSRoom Properties |
The SFSRoom type exposes the following members.
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.
|