getRoom()
Availability:
SmartFoxServer Lite / Basic / Pro
Usage:
smartFox.getRoom(roomId <integer/String>)
Description:
Get a propertlylist describing the room with a roomId.
Check the Room Properties for more info on the properties in the propertylist.
Parameters:
roomId | the parameter is accepted as a integer or String. You can pass the numeric id of the room as integer or the name of the room as a String. |
Returns:
A propertylist describing the room. (For more info about this object check the onRoomListUpdate event)
Example:
put smartFox.getRoom(15)
-- [#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]
See also:
getRoomList()