Function 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
 addBuddy, SmartFoxClient
 autoJoin, SmartFoxClient
C
 clearBuddyList, SmartFoxClient
 clone, SFSEvent
 connect, SmartFoxClient
 createRoom, SmartFoxClient
D
 disconnect, SmartFoxClient
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
I
 isGame, Room
 isLimbo, Room
 isModerator, User
 isPrivate, Room
 isSpectator, User
 isTemp, Room
J
 joinRoom, SmartFoxClient
L
 leaveRoom, SmartFoxClient
 loadBuddyList, SmartFoxClient
 login, SmartFoxClient
 logout, SmartFoxClient
R
 removeBuddy, SmartFoxClient
 Room, Room
 roundTripBench, SmartFoxClient
S
 sendModeratorMessage, SmartFoxClient
 sendObject, SmartFoxClient
 sendObjectToGroup, SmartFoxClient
 sendPrivateMessage, SmartFoxClient
 sendPublicMessage, SmartFoxClient
 sendXtMessage, SmartFoxClient
 setBuddyVariables, SmartFoxClient
 setRoomVariables, SmartFoxClient
 setUserVariables, SmartFoxClient
 SFSEvent, SFSEvent
 SmartFoxClient, SmartFoxClient
 switchSpectator, SmartFoxClient
T
 toString, SFSEvent
U
 uploadFile, SmartFoxClient
 User, User
public function addBuddy(buddyName: String):void
Add a new buddy to the buddy list.
public function autoJoin():void
Automatically join the the default room (if exist) for the current Zone.
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 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 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 function removeBuddy(buddyName: String):void
Remove a buddy from the buddy list.
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.
public function sendModeratorMessage(message: String,  
type: String,  
id: int = -1):void
Send a moderator message to an entire Zone, a Room or a single User.
public function sendObject(obj: Object,  
roomId: int = -1):void
Send an Actionscript object to the other users in the room.
public function sendObjectToGroup(obj: Object,  
userList: Array,  
roomId: int = -1):void
Send an Actionscript object to a group of users in the room.
public function sendPrivateMessage(message: String,  
recipientId: int,  
roomId: int = -1):void
Send a private message to a user.
public function sendPublicMessage(message: String,  
roomId: int = -1):void
Send a public message.
public function sendXtMessage(xtName: String,  
cmd: String,  
paramObj: *,  
type: String = "xml",
roomId: int = -1):void
Send a request to a server side extension.
public function setBuddyVariables(varList: Array):void
Set one or more Buddy Variables.
public function setRoomVariables(varList: Array,  
roomId: int = -1,
setOwnership: Boolean = true):void
Set on or more Room Variables.
public function setUserVariables(varObj: Object,  
roomId: int = -1):void
Set on or more User Variables.
public function SFSEvent(type: String,
params: Object)
The default contructor.
public function SmartFoxClient(debug: Boolean = false)
The default contructor.
public function switchSpectator(roomId: int = -1):void
Turn a spectator inside a game room into a player.
function toString():String
Return a String containing all the properties of the current instance.
public function uploadFile(fileRef: FileReference,  
id: int = -1,
nick: String = "",
port: int = -1):void
Upload a file to the embedded webserver.
public function User(id: int,
name: String)
The default contructor.