Room Properties
Availability:
SmartFoxServer Basic / Pro
Description:
Each Room is described by a propertylist. They are returned by different
methods and events of the API.
Below follows a list of available room properties:
Properties:
#id | the room Id <integer> | |
#myPlayerIndex | the player Id <integer> | |
#maxSpectators | the max number of spectators for that room <integer> | |
#maxUsers | the max number of users for that room <integer> | |
#name | the room name <String > | |
#spectatorCount | the number of spectators in the room <integer> | |
#userCount | the number of users in the room <integer> | |
#userList | a list with propertylists for each user | |
#variables | a propertylist of all the room variables | |
visGame | true if the room is a game room | |
#isLimbo | true if the Limbo flag is set for this room | |
#isPrivate | true if the room is private (password protected) | |
#isTemp | true if the room is temporary (always true for user created rooms) |
Example:
This is an example of the properties found in a room propertylist:
[#myPlayerIndex: 0.0000, #variables: [:], #userList: [#0: [#pid: -1.0000, #isMod: 0, #isSpec: 0, #variables: [], #name: "username", #id: 0.0000]], #specCount: NAN, #userCount: 1.0000, #description: "", #updatable: 0, #limbo: 0, #priv: 0, #game: 0, #temp: 0, #maxSpectators: 0.0000, #maxUsers: 50.0000, #name: "The Hall", #id: 1.0000]