The Room type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| ContainsUser |
Returns true if the the User is found in this Room
| |
| ContainsVariable |
Returns true if a RoomVariable with the passed name exists in the Room
| |
| GetUserById |
Finds a User from its Id
| |
| GetUserByName |
Finds a User from its name
| |
| GetVariable |
Gets a RoomVariable in the Room
| |
| GetVariables |
Return the full list of RoomVariables in the Room
|
Properties
| Name | Description | |
|---|---|---|
| Capacity | ||
| GroupId |
The Room Group name
| |
| Id |
The unique Id of the Room
| |
| IsGame |
Returns true is this is a game Room
| |
| IsHidden |
Returns true if the Room hidden flag is turned on.
| |
| IsJoined |
Returns true if the Room is joined by the client User
| |
| IsPasswordProtected |
Returns true if the Room requires a password to be joined
| |
| MaxSpectators |
Get the max number of Spectators allowed in the Room (applies only for game Rooms)
| |
| MaxUsers |
Get the max number of Users allowed in the Room
| |
| Name |
The unique name of the Room
| |
| Properties |
A generic object that can be used to store any Room custom data needed at runtime.
| |
| RoomManager |
A reference to the RoomManager, managing this Room
| |
| SpectatorCount |
Get the number of Spectators in the Room (applies only for game Rooms)
| |
| UserCount |
Get the number of Users in the Room
| |
| UserList |
The Room User-list
|