Room

Availability:

Flash Player 6.0
SmartFoxServer Basic / Pro

Description:

The Room class is used internally by the SmartFoxClient object to store the properties of each room.
Also Room objects are returned by different methods and events of the API. Below follows a list of public methods available:

Public Methods:

getId()   returns the room Id
getMyPlayerIndex()   returns the player Id
getMaxSpectators()   returns the max number of spectators for that room
getMaxUsers()   returns the max number of users for that room
getName()   returns the room name
getSpectatorCount()   returns the number of spectators in the room
getUser(userId)   returns a user object
getUserCount()   returns the number of users in the room
getUserList()   returns a list of user objects
getVariable(varName)   returns a room variable
getVariables()   returns a list of all the room variables
isGame()   returns true if the room is a game room
isLimbo()   returns true if the Limbo flag is set for this room
isPrivate()   returns true if the room is private (password protected)
isTemp()   returns true if the room is temporary (always true for user created rooms)