| 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 |
The property stores the id of the last room the user has entered.
public var activeRoomId: int
Add a new buddy to the buddy list.
public function addBuddy( buddyName: String ):void
A boolean flag indicating if the user is recognized as moderator.
public var amIModerator: Boolean
Automatically join the the default room (if exist) for the current Zone.
public function autoJoin():void
An array containing the objects representing each buddy of the client’s buddy list.
public var buddyList: Array
Remove all contacts from the buddy list.
public function clearBuddyList():void
Create and returns a copy of the current instance.
function clone():Event
Establish a connection to SmartFoxServer.
public function connect( ipAdr: String, port: int = 9339 ):void
Dynamically create a new room in the current Zone.
public function createRoom( roomObj: Object, roomId: int = -1 ):void
Toggles the client-side debugging informations.
public var debug: Boolean
Closes the current connection to SmartFoxServer.
public function disconnect():void
Get the currently active Room object.
public function getActiveRoom():Room
Get the list of rooms.
public function getAllRooms():Array
Request the roomId(s) of the room(s) a buddy is currently joined to.
public function getBuddyRoom( buddy: Object ):void
Get the id of the room.
public function getId():int
Get the user id.
public function getId():int
Retrieve the maximum number of spectators that can join the room.
public function getMaxSpectators():int
Retrieve the maximum number of users that can join the room.
public function getMaxUsers():int
Retrieve the player id for the current user in the room.
public function getMyPlayerIndex():int
Get the name of the room.
public function getName():String
Get the user name.
public function getName():String
Retrieve the player id of the user.
public function getPlayerId():int
Gets a random string key from the server.
public function getRandomKey():void
Get a Room object from its id.
public function getRoom( rid: int ):Room
Get a Room object from its name.
public function getRoomByName( roomName: String ):Room
Retrieve the list of rooms in the current Zone.
public function getRoomList():void
Retrieve the number of spectators currently inside the room.
public function getSpectatorCount():int
Get the default upload path of the embedded webserver.
public function getUploadPath():String
Look for a user in the room.
public function getUser( userId: * ):User
Retrieve the number of users currently inside the room.
public function getUserCount():int
Get the list of users currently inside the room.
public function getUserList():Array
Retrieve a Room Variable.
public function getVariable( varName: String ):Object
Retrieve a User Variable.
public function getVariables():Array
Retrieve the list of all Room Variables.
public function getVariables():Array
Get the SmartFoxServer Flash API version.
public function getVersion():String
The TCP port used by the embedded webserver.
public var httpPort: int
A boolean flag indicating if you are connected to the server.
public function get isConnected():Boolean
A boolean flag indicating if the room is a “game room”.
public function isGame():Boolean
A boolean flag indicating if the room is in “limbo mode”.
public function isLimbo():Boolean
A boolean flag indicating if the user is a Moderator in the current Zone.
public function isModerator():Boolean
A boolean flag indicating if the room is private (password protected).
public function isPrivate():Boolean
A boolean flag indicating if the user is a spectator in the current room.
public function isSpectator():Boolean
A boolean flag indicating if the room is dynamic/temporary.
public function isTemp():Boolean
Join a room.
public function joinRoom( newRoom: *, pword: String = "", isSpectator: Boolean = false, dontLeave: Boolean = false, oldRoom: int = -1 ):void
Disconnect the user from the specified room.
public function leaveRoom( roomId: int ):void
Loads the buddy list for the current user.
public function loadBuddyList():void
Perform the default login procedure.
public function login( zone: String, name: String, pass: String ):void
Log the user out of the current Zone.
public function logout():void
A number representing the current userId.
public var myUserId: int
A string representing the name we’re currently using in the server.
public var myUserName: String
Contains the parameters passed by the SmartFoxClient class.
public var params: Object
A number representing the id of the client as a player.
public var playerId: int
Get/set the character used as a separator for the Raw/String protocol.
public function get rawProtocolSeparator():String
Remove a buddy from the buddy list.
public function removeBuddy( buddyName: String ):void
The default contructor.
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 )
Send a roundTrip request to the server to test the speed of the connection.
public function roundTripBench():void