+
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.
changingRoom
A boolean flag indicating if the process of joining a new room is in progress.
CONNECTION_MODE_DISCONNECTED
public static constant property
Connection mode: "disconnected".
CONNECTION_MODE_HTTP
public static constant property
Connection mode: "http".
CONNECTION_MODE_SOCKET
public static constant 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.
isConnected
A boolean flag indicating if the current user is connected to the server.
MODMSG_TO_ROOM
public static constant property
Moderator message type: "to room".
MODMSG_TO_USER
public static constant property
Moderator message type: "to user".
MODMSG_TO_ZONE
public static constant 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
public static constant property (event handler)
Dispatched when a message from the Administrator is received.
onBuddyList
public static constant property (event handler)
Dispatched when the buddy list for the current user is received or a buddy is added/removed.
onBuddyListError
public static constant property (event handler)
Dispatched when an error occurs while loading the buddy list.
onBuddyListUpdate
public static constant property (event handler)
Dispatched when the status or variables of a buddy in the buddy list change.
onBuddyPermissionRequest
public static constant property (event handler)
Dispatched when the current user receives a request to be added to the buddy list of another user.
onBuddyRoom
public static constant property (event handler)
Dispatched in response to a
SmartFoxClient.getBuddyRoom
request.
onConfigLoadFailure
public static constant property (event handler)
Dispatched when an error occurs while loading the external SmartFoxClient configuration file.
onConfigLoadSuccess
public static constant property (event handler)
Dispatched when the external SmartFoxClient configuration file has been loaded successfully.
onConnection
public static constant property (event handler)
Dispatched in response to the
SmartFoxClient.connect
request.
onConnectionLost
public static constant property (event handler)
Dispatched when the connection with SmartFoxServer is closed (either from the client or from the server).
onCreateRoomError
public static constant property (event handler)
Dispatched when an error occurs during the creation of a room.
onDebugMessage
public static constant property (event handler)
Dispatched when a debug message is traced by the SmartFoxServer API.
onExtensionResponse
public static constant property (event handler)
Dispatched when a command/response from a server-side extension is received.
onJoinRoom
public static constant property (event handler)
Dispatched when a room is joined successfully.
onJoinRoomError
public static constant property (event handler)
Dispatched when an error occurs while joining a room.
onLogin
public static constant property (event handler)
Dispatched when the login to a SmartFoxServer zone has been attempted.
onLogout
public static constant property (event handler)
Dispatched when the user logs out successfully.
onModeratorMessage
public static constant property (event handler)
Dispatched when a message from a Moderator is received.
onObjectReceived
public static constant property (event handler)
Dispatched when an Actionscript object is received.
onPlayerSwitched
public static constant property (event handler)
Dispatched in response to the
SmartFoxClient.switchPlayer
request.
onPrivateMessage
public static constant property (event handler)
Dispatched when a private chat message is received.
onPublicMessage
public static constant property (event handler)
Dispatched when a public chat message is received.
onRandomKey
public static constant property (event handler)
Dispatched in response to a
SmartFoxClient.getRandomKey
request.
onRoomAdded
public static constant property (event handler)
Dispatched when a new room is created in the zone where the user is currently logged in.
onRoomDeleted
public static constant property (event handler)
Dispatched when a room is removed from the zone where the user is currently logged in.
onRoomLeft
public static constant property (event handler)
Dispatched when a room is left in multi-room mode, in response to a
SmartFoxClient.leaveRoom
request.
onRoomListUpdate
public static constant property (event handler)
Dispatched when the list of rooms available in the current zone is received.
onRoomVariablesUpdate
public static constant property (event handler)
Dispatched when Room Variables are updated.
onRoundTripResponse
public static constant property (event handler)
Dispatched when a response to the
SmartFoxClient.roundTripBench
request is received.
onSpectatorSwitched
public static constant property (event handler)
Dispatched in response to the
SmartFoxClient.switchSpectator
request.
onUserCountChange
public static constant property (event handler)
Dispatched when the number of users and/or spectators changes in a room within the current zone.
onUserEnterRoom
public static constant property (event handler)
Dispatched when another user joins the current room.
onUserLeaveRoom
public static constant property (event handler)
Dispatched when a user leaves the current room.
onUserVariablesUpdate
public static constant property (event handler)
Dispatched when a user in the current room updates his/her User Variables.
params
An object containing all the parameters related to the dispatched event.
playerId
The current user's id as a player in a game room.
port
The SmartFoxServer connection port.
properties
rawProtocolSeparator
Get/set the character used as separator for the String (raw) protocol.
smartConnect
A boolean flag indicating if the BlueBox http connection should be used in case a socket connection is not available.
XTMSG_TYPE_JSON
public static constant property
Server-side extension request/response protocol: JSON.
XTMSG_TYPE_STR
public static constant property
Server-side extension request/response protocol: String (aka "raw protocol").
XTMSG_TYPE_XML
public static constant property
Server-side extension request/response protocol: XML.