getProperties

Availability:

SmartFoxServer Pro (1.5.0 or higher)

Usage:

smartFox.getProperties()

Description:

Gives you a propertylist of all smartFox properties.

#activeRoomId   the id of the last room the user has entered
#amIModerator   true if the user is recognized as moderator
#buddyList   A list of buddies in the client's buddy list. Each buddy in the list is a propertylist with the following properties: #id, #name, #isOnline, #variables
#debug   true if debugging is enabled in the message window
#httpPort   the TCP port used by the embedded webserver
#myUserId   the current userId
#myUserName   the current user name
#roomList   a list with propertylists representing each room. Check the Room Properties for more info on the properties in the propertylist.


Parameters:

none      

Returns:

Returns propertylist of all smartFox properties.

Example:

 put("smartfox properties: " & smartfox.getProperties())
 -- [#activeRoomId: 1.0000, #amIModerator: 0, #buddyList: [], #debug: 1.0000, #httpPort: 8080, #myUserId: 2, #myUserName: "aa", #playerId: 0.0000, #roomList: [[:], [#myPlayerIndex: 0.0000, #variables: [:], #userList: [#2: [#pid: -1.0000, #isMod: 0, #isSpec: 0, #variables: [#], #name: "aa", #id: 2.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:

setHttpPort(), uploadFile()