Index
$#! · 0-9 · A · B · C · D · E · F · G · H · I · J · K · L · M · N · O · P · Q · R · S · T · U · V · W · X · Y · Z
A
 activeRoomId, SmartFoxClient
 addBuddy, SmartFoxClient
 amIModerator, SmartFoxClient
 autoJoin, SmartFoxClient
B
 buddyList, SmartFoxClient
C
 clearBuddyList, SmartFoxClient
 clone, SFSEvent
 connect, SmartFoxClient
 Constants, SFSEvent
 createRoom, SmartFoxClient
D
 debug, SmartFoxClient
 disconnect, SmartFoxClient
F
 Functions
G
 getActiveRoom, SmartFoxClient
 getAllRooms, SmartFoxClient
 getBuddyRoom, SmartFoxClient
 getId
 getMaxSpectators, Room
 getMaxUsers, Room
 getMyPlayerIndex, Room
 getName
 getPlayerId, User
 getRandomKey, SmartFoxClient
 getRoom, SmartFoxClient
 getRoomByName, SmartFoxClient
 getRoomList, SmartFoxClient
 getSpectatorCount, Room
 getUploadPath, SmartFoxClient
 getUser, Room
 getUserCount, Room
 getUserList, Room
 getVariable
 getVariables
 getVersion, SmartFoxClient
H
 httpPort, SmartFoxClient
I
 isConnected, SmartFoxClient
 isGame, Room
 isLimbo, Room
 isModerator, User
 isPrivate, Room
 isSpectator, User
 isTemp, Room
J
 joinRoom, SmartFoxClient
L
 leaveRoom, SmartFoxClient
 loadBuddyList, SmartFoxClient
 login, SmartFoxClient
 logout, SmartFoxClient
M
 myUserId, SmartFoxClient
 myUserName, SmartFoxClient
O
 onAdminMessage, SFSEvent
 onBuddyList, SFSEvent
 onBuddyListError, SFSEvent
 onBuddyListUpdate, SFSEvent
 onBuddyRoom, SFSEvent
 onConnection, SFSEvent
 onConnectionLost, SFSEvent
 onCreateRoomError, SFSEvent
 onDebugMessage, SFSEvent
 onExtensionResponse, SFSEvent
 onJoinRoom, SFSEvent
 onJoinRoomError, SFSEvent
 onLogin, SFSEvent
 onLogout, SFSEvent
 onModeratorMessage, SFSEvent
 onObjectReceived, SFSEvent
 onPrivateMessage, SFSEvent
 onPublicMessage, SFSEvent
 onRandomKey, SFSEvent
 onRoomAdded, SFSEvent
 onRoomDeleted, SFSEvent
 onRoomLeft, SFSEvent
 onRoomListUpdate, SFSEvent
 onRoomVariablesUpdate, SFSEvent
 onRoundTripResponse, SFSEvent
 onSpectatorSwitched, SFSEvent
 onUserCountChange, SFSEvent
 onUserEnterRoom, SFSEvent
 onUserLeaveRoom, SFSEvent
 onUserVariablesUpdate, SFSEvent
P
 params, SFSEvent
 playerId, SmartFoxClient
 Properties, SmartFoxClient
R
 rawProtocolSeparator, SmartFoxClient
 removeBuddy, SmartFoxClient
 Room
 roundTripBench, SmartFoxClient
public var activeRoomId: int
The property stores the id of the last room the user has entered.
public function addBuddy(buddyName: String):void
Add a new buddy to the buddy list.
public var amIModerator: Boolean
A boolean flag indicating if the user is recognized as moderator.
public function autoJoin():void
Automatically join the the default room (if exist) for the current Zone.
public var buddyList: Array
An array containing the objects representing each buddy of the client’s buddy list.
public function clearBuddyList():void
Remove all contacts from the buddy list.
function clone():Event
Create and returns a copy of the current instance.
public function connect(ipAdr: String,  
port: int = 9339):void
Establish a connection to SmartFoxServer.
public function createRoom(roomObj: Object,  
roomId: int = -1):void
Dynamically create a new room in the current Zone.
public var debug: Boolean
Toggles the client-side debugging informations.
public function disconnect():void
Closes the current connection to SmartFoxServer.
public function getActiveRoom():Room
Get the currently active Room object.
public function getAllRooms():Array
Get the list of rooms.
public function getBuddyRoom(buddy: Object):void
Request the roomId(s) of the room(s) a buddy is currently joined to.
public function getId():int
Get the id of the room.
public function getId():int
Get the user id.
public function getMaxSpectators():int
Retrieve the maximum number of spectators that can join the room.
public function getMaxUsers():int
Retrieve the maximum number of users that can join the room.
public function getMyPlayerIndex():int
Retrieve the player id for the current user in the room.
public function getName():String
Get the name of the room.
public function getName():String
Get the user name.
public function getPlayerId():int
Retrieve the player id of the user.
public function getRandomKey():void
Gets a random string key from the server.
public function getRoom(rid: int):Room
Get a Room object from its id.
public function getRoomByName(roomName: String):Room
Get a Room object from its name.
public function getRoomList():void
Retrieve the list of rooms in the current Zone.
public function getSpectatorCount():int
Retrieve the number of spectators currently inside the room.
public function getUploadPath():String
Get the default upload path of the embedded webserver.
public function getUser(userId: *):User
Look for a user in the room.
public function getUserCount():int
Retrieve the number of users currently inside the room.
public function getUserList():Array
Get the list of users currently inside the room.
public function getVariable(varName: String):Object
Retrieve a Room Variable.
public function getVariables():Array
Retrieve a User Variable.
public function getVariables():Array
Retrieve the list of all Room Variables.
Retrieve the list of all User Variables.
public function getVersion():String
Get the SmartFoxServer Flash API version.
public var httpPort: int
The TCP port used by the embedded webserver.
public function get isConnected():Boolean
A boolean flag indicating if you are connected to the server.
public function isGame():Boolean
A boolean flag indicating if the room is a “game room”.
public function isLimbo():Boolean
A boolean flag indicating if the room is in “limbo mode”.
public function isModerator():Boolean
A boolean flag indicating if the user is a Moderator in the current Zone.
public function isPrivate():Boolean
A boolean flag indicating if the room is private (password protected).
public function isSpectator():Boolean
A boolean flag indicating if the user is a spectator in the current room.
public function isTemp():Boolean
A boolean flag indicating if the room is dynamic/temporary.
public function joinRoom(newRoom: *,  
pword: String = "",
isSpectator: Boolean = false,
dontLeave: Boolean = false,
oldRoom: int = -1):void
Join a room.
public function leaveRoom(roomId: int):void
Disconnect the user from the specified room.
public function loadBuddyList():void
Loads the buddy list for the current user.
public function login(zone: String,
name: String,
pass: String):void
Perform the default login procedure.
public function logout():void
Log the user out of the current Zone.
public var myUserId: int
A number representing the current userId.
public var myUserName: String
A string representing the name we’re currently using in the server.
Dispatched when a message from the Administrator is received.
Dispatched when the buddy list is received.
Dispatched when an error occurs while loading the buddy list.
Dispatched when the status of a buddy in the buddy list changes.
Dispatched in response to a SmartFoxClient.getBuddyRoom request.
Dispatched when the connection to SmartFoxServer succeeded or failed.
Dispatched when the connection with SmartFoxServer is lost.
Dispatched when an error occurs during the creation of a room.
Dispatched when a debug message is traced by the SmartFoxServer API.
Dispatched when a response from a server-side extension is received.
Dispatched when a room is joined successfully.
Dispatched when an error occurs while joining a room.
Dispatched after the login to SmartFoxServer has been attempted.
Dispatched after the user logged out successfully.
Dispatched when a message from a Moderator is received.
Dispatched when an Actionscript object is received.
Dispatched when a private message is received.
Dispatched when a public message is received.
Dispatched when a response to the SmartFoxClient.getRandomKey request is received.
Dispatched when a new room is created.
Dispatched when a room is removed.
Dispatched when a room is left in multi-room mode, in response of a SmartFoxClient.leaveRoom request.
Dispatched when the list of rooms available in the Zone is received.
Dispatched when room variables are updated in a certain room.
Dispatched when a response to the SmartFoxClient.roundTripBench request is received.
Dispatched when a response to the SmartFoxClient.switchSpectator request is received.
Dispatched when the user/spectator count of a room changed.
Dispatched when a user joins the current room.
Dispatched when a user leaves the current room.
Dispatched when a user updates his/her User Variables.
public var params: Object
Contains the parameters passed by the SmartFoxClient class.
public var playerId: int
A number representing the id of the client as a player.
public function get rawProtocolSeparator():String
Get/set the character used as a separator for the Raw/String protocol.
public function removeBuddy(buddyName: String):void
Remove a buddy from the buddy list.
The Room class is used internally by the SmartFoxClient object to store the properties of each room.
public function Room(id: int,  
name: String,  
maxUsers: int,  
maxSpectators: int,  
isTemp: Boolean,  
isGame: Boolean,  
isPrivate: Boolean,  
isLimbo: Boolean,  
userCount: int = 0,
specCount: int = 0)
The default contructor.
public function roundTripBench():void
Send a roundTrip request to the server to test the speed of the connection.