it.gotoandplay.smartfoxserver.Room
Availability:
Flash Player 7, 8
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():Number | returns the room Id | |
getMyPlayerIndex():Number | returns the player Id | |
getMaxSpectators():Number | returns the max number of spectators for that room | |
getMaxUsers():Number | returns the max number of users for that room | |
getName():String | returns the room name | |
getSpectatorCount():Number | returns the number of spectators in the room | |
getUser(userId:Number):User | returns a user object | |
getUserCount():Number | returns the number of users in the room | |
getUserList():Object | returns a list of user objects | |
getVariable(varName:String):Object | returns a room variable | |
getVariables():Object | returns a list of all the room variables | |
isGame():Boolean | returns true if the room is a game room | |
isLimbo():Boolean | returns true if the Limbo flag is set for this room | |
isPrivate():Boolean | returns true if the room is private (password protected) | |
isTemp():Boolean | returns true if the room is temporary (always true for user created rooms) |