+Show TOC
×Hide TOC

All properties

activeRoomId
- The property stores the id of the last room joined by the current user.
amIModerator
- A boolean flag indicating if the user is recognized as Moderator.
blueBoxIpAddress
- The BlueBox IP address.
blueBoxPort
- The BlueBox connection port.
buddyList
- An array containing the objects representing each buddy of the user's buddy list.
CONNECTION_MODE_DISCONNECTED static property
- Connection mode: "disconnected".
CONNECTION_MODE_HTTP static property
- Connection mode: "http".
CONNECTION_MODE_SOCKET static property
- Connection mode: "socket".
debug
- Toggle the client-side debugging informations.
defaultZone
- The default login zone.
httpPollSpeed
- The minimum interval between two polling requests when connecting to SmartFoxServer via BlueBox module.
httpPort
- The TCP port used by the embedded webserver.
ipAddress
- The SmartFoxServer IP address.
MODMSG_TO_ROOM static property
- Moderator message type: "to room".
MODMSG_TO_USER static property
- Moderator message type: "to user".
MODMSG_TO_ZONE static property
- Moderator message type: "to zone".
myBuddyVars
- The current user's Buddy Variables.
myUserId
- The current user's SmartFoxServer id.
myUserName
- The current user's SmartFoxServer username.
onAdminMessage
- Called when a message from the Administrator is received.
onBuddyList
- Called when the buddy list for the current user is received or a buddy is added/removed.
onBuddyListError
- Called when an error occurs while loading the buddy list.
onBuddyListUpdate
- Called when the status or variables of a buddy in the buddy list change.
onBuddyPermissionRequest
- Called when the current user receives a request to be added to the buddy list of another user.
onBuddyRoom
- Called when a response to a getBuddyRoom request is received.
onConfigLoadFailure
- Called when an error occurs while loading the external SmartFoxClient configuration file.
onConfigLoadSuccess
- Called when the external SmartFoxClient configuration file has been loaded successfully.
onConnection
- Called when a response to the connect request is received.
onConnectionLost
- Called when the connection with SmartFoxServer is closed (either from the client or from the server).
onCreateRoomError
- Called when an error occurs during the creation of a room.
onExtensionResponse
- Called when a command/response from a server-side extension is received.
onJoinRoom
- Called when a room is joined successfully.
onJoinRoomError
- Called when an error occurs while joining a room.
onLogin
- Called when the login to a SmartFoxServer zone has been attempted.
onLogout
- Called when the user logs out successfully.
onModeratorMessage
- Called when a message from a Moderator is received.
onObjectReceived
- Called when an Actionscript object is received.
onPlayerSwitched
- Called in response to the switchPlayer request.
onPrivateMessage
- Called when a private chat message is received.
onPublicMessage
- Called when a public chat message is received.
onRandomKey
- Called when a response to a getRandomKey request is received.
onRoomAdded
- Called when a new room is created in the zone where the user is currently logged in.
onRoomDeleted
- Called when a room is removed from the zone where the user is currently logged in.
onRoomLeft
- Called when a room is left in multi-room mode, after a response to a leaveRoom request is received.
onRoomListUpdate
- Called when the list of rooms available in the current zone is received.
onRoomVariablesUpdate
- Called when Room Variables are updated.
onRoundTripResponse
- Called when a response to the roundTripBench request is received.
onSpectatorSwitched
- Called when a response to the switchSpectator request is received.
onUserCountChange
- Called when the number of users and/or spectators changes in a room within the current zone.
onUserEnterRoom
- Called when another user joins the current room.
onUserLeaveRoom
- Called when a user leaves the current room.
onUserVariablesUpdate
- Called when a user in the current room updates his/her User Variables.
playerId
- The current user's id as a player in a game room.
port
- The SmartFoxServer connection port.
PROTOCOL_JSON static property
- Server-side extension request/response protocol: JSON.
PROTOCOL_STR static property
- Server-side extension request/response protocol: String (aka "raw protocol").
PROTOCOL_XML static property
- Server-side extension request/response protocol: XML.
rawProtocolSeparator
- Get/set the character used as separator for the String (raw) protocol.
roomList
- The list of rooms in the current zone.
smartConnect
- A boolean flag indicating if the BlueBox http connection should be used in case a socket connection is not available.
socketConnectionTimeout
- The amount of milliseconds to wait before attempting a BlueBox connection.