The Room type exposes the following members.

Methods

  NameDescription
Public methodContainsUser
Returns true if the the User is found in this Room
Public methodContainsVariable
Returns true if a RoomVariable with the passed name exists in the Room
Public methodGetUserById
Finds a User from its Id
Public methodGetUserByName
Finds a User from its name
Public methodGetVariable
Gets a RoomVariable in the Room
Public methodGetVariables
Return the full list of RoomVariables in the Room

Properties

  NameDescription
Public propertyCapacity
Public propertyGroupId
The Room Group name
Public propertyId
The unique Id of the Room
Public propertyIsGame
Returns true is this is a game Room
Public propertyIsHidden
Returns true if the Room hidden flag is turned on.
Public propertyIsJoined
Returns true if the Room is joined by the client User
Public propertyIsPasswordProtected
Returns true if the Room requires a password to be joined
Public propertyMaxSpectators
Get the max number of Spectators allowed in the Room (applies only for game Rooms)
Public propertyMaxUsers
Get the max number of Users allowed in the Room
Public propertyName
The unique name of the Room
Public propertyProperties
A generic object that can be used to store any Room custom data needed at runtime.
Public propertyRoomManager
A reference to the RoomManager, managing this Room
Public propertySpectatorCount
Get the number of Spectators in the Room (applies only for game Rooms)
Public propertyUserCount
Get the number of Users in the Room
Public propertyUserList
The Room User-list

See Also