+Show TOC
×Hide TOC

All methods

addBuddy
- Add a user to the buddy list.
addUser
- Add a user to the room.
autoJoin
- Automatically join the the default room (if existing) for the current zone.
clearBuddyList
- Remove all users from the buddy list.
clearUserList
- Reset users list.
clearVariables Room
- Reset Room Variables.
clearVariables User
- Reset User Variabless.
clone
- Get a copy of the current instance.
connect
- Establish a connection to SmartFoxServer.
createRoom
- Dynamically create a new room in the current zone.
disconnect
- Close the current connection to SmartFoxServer.
getActiveRoom
- Get the currently active Room object.
getAllRooms
- Get the list of rooms in the current zone.
getBuddyById
- Get a buddy from the buddy list, using the user id as key.
getBuddyByName
- Get a buddy from the buddy list, using the buddy's username as key.
getBuddyRoom
- Request the room id(s) of the room(s) where a buddy is currently located into.
getConnectionMode
- Get the current connection mode.
getId Room
- Get the id of the room.
getId User
- Get the id of the user.
getMaxSpectators
- Retrieve the maximum number of spectators that can join the room.
getMaxUsers
- Retrieve the maximum number of users that can join the room.
getMyPlayerIndex
- Retrieve the player id for the current user in the room.
getName Room
- Get the name of the room.
getName User
- Get the name of the user.
getPlayerId
- Retrieve the player id of the user.
getRandomKey
- Retrieve a random string key from the server.
getRoom
- Get a Room object, using its id as key.
getRoomByName
- Get a Room object, using its name as key.
getRoomList
- Retrieve the updated list of rooms in the current zone.
getSpectatorCount
- Retrieve the number of spectators currently inside the room.
getUploadPath
- Get the default upload path of the embedded webserver.
getUser
- Retrieve a user currently in the room.
getUserCount
- Retrieve the number of users currently inside the room.
getUserList
- Get the list of users currently inside the room.
getVariable Room
- Retrieve a Room Variable.
getVariable User
- Retrieve a User Variable.
getVariables Room
- Retrieve the list of all Room Variables.
getVariables User
- Retrieve the list of all User Variables.
getVersion
- Get the SmartFoxServer Flash API version.
isGame
- A boolean flag indicating if the room is a "game room".
isLimbo
- A boolean flag indicating if the room is in "limbo mode".
isModerator
- A boolean flag indicating if the user is a Moderator in the current zone.
isPrivate
- A boolean flag indicating if the room is private (password protected).
isSpectator
- A boolean flag indicating if the user is a spectator in the current room.
isTemp
- A boolean flag indicating if the room is dynamic/temporary.
joinRoom
- Join a room.
leaveRoom
- Disconnect the user from the given room.
loadBuddyList
- Load the buddy list for the current user.
loadConfig
- Load a client configuration file.
login
- Perform the default login procedure.
logout
- Log the user out of the current zone.
removeBuddy
- Remove a buddy from the buddy list.
removeUser
- Remove a user from the room.
roundTripBench
- Send a roundtrip request to the server to test the connection' speed.
sendBuddyPermissionResponse
- Grant current user permission to be added to a buddy list.
sendModeratorMessage
- Send a Moderator message to the current zone, the current room or a specific user in the current room.
sendObject
- Send an Actionscript object to the other users in the current room.
sendObjectToGroup
- Send an Actionscript object to a group of users in the room.
sendPrivateMessage
- Send a private message to a user.
sendPublicMessage
- Send a public message.
sendXtMessage
- Send a request to a server side extension.
setBuddyBlockStatus
- Block or unblock a user in the buddy list.
setBuddyVariables
- Set the current user's Buddy Variables.
setIsLimbo
- Set the isLimbo property.
setIsSpectator
- Set the isSpectator property.
setModerator
- Set the isModerator property.
setMyPlayerIndex
- Set the myPlayerId property.
setPlayerId
- Set the playerId property.
setRoomVariables
- Set one or more Room Variables.
setSpectatorCount
- Se the number of spectators in the room.
setUserCount
- Se the number of users in the room.
setUserVariables
- Set on or more User Variables.
setVariables Room
- Set the Room Variables.
setVariables User
- Set the User Variabless.
switchPlayer
- Turn a player inside a game room into a spectator.
switchSpectator
- Turn a spectator inside a game room into a player.
toString
- Get a string containing all the properties of the current instance.
uploadFile
- Upload a file to the embedded webserver.