SmartFoxClient

var smartFox:SmartFoxServer = new SmartFoxServer(true)

var room:Room = smartFox.getRoom(smartFox.activeRoomId)
trace("Current room is: " + room.getName())

if (smartfox.amIModerator)
    trace("I'm a Moderator in this zone")
else
    trace("I'm a standard user")

for (var b:String in smartFox.buddyList)
{
    var buddy:Object = smartFox.buddyList[b]

    // Trace buddy properties
    trace("Buddy id: " + buddy.id)
    trace("Buddy name: " + buddy.name)
    trace("Is buddy online? " + buddy.isOnline ? "Yes" : "No")
    trace("Is buddy blocked? " + buddy.isBlocked ? "Yes" : "No")

    // Trace all Buddy Variables
    for (var v:String in buddy.variables)
        trace("\t" + v + " --> " + buddy.variables[v])
}

var smartFox:SmartFoxClient = new SmartFoxClient()
var runningLocally:Boolean = true

var ip:String
var port:int

if (runningLocally)
{
    smartFox.debug = true
    ip = "127.0.0.1"
    port = 9339
}
else
{
    smartFox.debug = false
    ip = "100.101.102.103"
    port = 9333
}

smartFox.connect(ip, port)

smartFox.httpPollSpeed = 200

trace("HTTP port is: " + smartfox.httpPort)

trace("My connection status: " + (smartFox.isConnected ? "connected" : "not connected"))

for (var v:String in smartFox.myBuddyVars)
    trace("Variable " + v + " --> " + smartFox.myBuddyVars[v])

trace("My user ID is: " + smartFox.myUserId)

trace("I logged in as: " + smartFox.myUserName)

trace("I'm player " + smartFox.playerId)

smartFox.rawProtocolSeparator = "|"

• Dispatched when the buddy list for the current user is received or a buddy is added/removed.

• Dispatched when an error occurs while loading the buddy list.

• Dispatched when the current user receives a request to be added to the buddy list of another user.

smartFox.addBuddy("jack")

• Dispatched when a room is joined successfully.

• Dispatched when an error occurs while joining a room.

smartFox.autoJoin()

• Dispatched when the buddy list for the current user is received or a buddy is added/removed.

smartFox.clearBuddyList()

• Dispatched in response to the connect request.

smartFox.connect("127.0.0.1", 9339)

• Dispatched when a new room is created in the zone where the user is currently logged in.

• Dispatched when an error occurs during the creation of a room.

var roomObj:Object = new Object()
roomObj.name = "The Cave"
roomObj.isGame = true
roomObj.maxUsers = 15

var variables:Array = new Array()
variables.push({name:"ogres", val:5, priv:true})
variables.push({name:"skeletons", val:4})

roomObj.vars = variables

smartFox.createRoom(roomObj)

• Dispatched when the connection with SmartFoxServer is closed (either from the client or from the server).

smartFox.disconnect()

var room:Room = smartFox.getActiveRoom()
trace("Current room is: " + room.getName())

var rooms:Array = smartFox.getAllRooms()

for (var r:String in rooms)
{
    var room:Room = rooms[r]
    trace("Room: " + room.getName())
}

var buddy:Object = smartFox.getBuddyById(25)

trace("Buddy id: " + buddy.id)
trace("Buddy name: " + buddy.name)
trace("Is buddy online? " + buddy.isOnline ? "Yes" : "No")
trace("Is buddy blocked? " + buddy.isBlocked ? "Yes" : "No")

trace("Buddy Variables:")
for (var v:String in buddy.variables)
    trace("\t" + v + " --> " + buddy.variables[v])

var buddy:Object = smartFox.getBuddyByName("jack")

trace("Buddy id: " + buddy.id)
trace("Buddy name: " + buddy.name)
trace("Is buddy online? " + buddy.isOnline ? "Yes" : "No")
trace("Is buddy blocked? " + buddy.isBlocked ? "Yes" : "No")

trace("Buddy Variables:")
for (var v:String in buddy.variables)
    trace("\t" + v + " --> " + buddy.variables[v])

• Dispatched in response to a getBuddyRoom request.

smartFox.addEventListener(SFSEvent.onBuddyRoom, onBuddyRoomHandler)

var buddy:Object = smartFox.getBuddyByName("jack")
smartFox.getBuddyRoom(buddy)

function onBuddyRoomHandler(evt:SFSEvent):void
{
    // Reach the buddy in his room
    smartFox.join(evt.params.idList[0])
}

    smartFox.addEventListener(SFSEvent.onConnection, onConnectionHandler)

smartFox.connect("127.0.0.1", 9339)

function onConnectionHandler(evt:SFSEvent):void
{
    trace("Connection mode: " + smartFox.getConnectionMode())
}

• Dispatched in response to a getRandomKey request.

smartFox.addEventListener(SFSEvent.onRandomKey, onRandomKeyHandler)

smartFox.getRandomKey()

function onRandomKeyHandler(evt:SFSEvent):void
{
    trace("Random key received from server: " + evt.params.key)
}

var roomObj:Room = smartFox.getRoom(15)
trace("Room name: " + roomObj.getName() + ", max users: " + roomObj.getMaxUsers())

var roomObj:Room = smartFox.getRoomByName("The Entrance")
trace("Room id: " + roomObj.getId() + ", max users: " + roomObj.getMaxUsers())

• Dispatched when the list of rooms available in the current zone is received.

smartFox.addEventListener(SFSEvent.onRoomListUpdate, onRoomListUpdateHandler)

smartFox.getRoomList()

function onRoomListUpdateHandler(evt:SFSEvent):void
{
    // Dump the names of the available rooms in the current zone
    for (var r:String in evt.params.roomList)
        trace(evt.params.roomList[r].getName())
}

var path:String = smartFox.getUploadPath()

trace("Current API version: " + smartFox.getVersion())

• Dispatched when a room is joined successfully.

• Dispatched when an error occurs while joining a room.

smartFox.joinRoom(10)

smartFox.joinRoom(12, "mypassword")

smartFox.joinRoom(15, "", false, true)

• Dispatched when a room is left in multi-room mode, in response to a leaveRoom request.

smartFox.leaveRoom(15)

• Dispatched when the buddy list for the current user is received or a buddy is added/removed.

• Dispatched when an error occurs while loading the buddy list.

smartFox.addEventListener(SFSEvent.onBuddyList, onBuddyListHandler)

smartFox.loadBuddyList()		

function onBuddyListHandler(evt:SFSEvent):void
{
    for (var b:String in smartFox.buddyList)
    {
        var buddy:Object = smartFox.buddyList[b]

        trace("Buddy id: " + buddy.id)
        trace("Buddy name: " + buddy.name)
        trace("Is buddy online? " + buddy.isOnline ? "Yes" : "No")
        trace("Is buddy blocked? " + buddy.isBlocked ? "Yes" : "No")

        trace("Buddy Variables:")
        for (var k:String in buddy.variables)
            trace("\t" + k + " --> " + buddy.variables[k])
    }
}

<SmartFoxClient>
    <ip>127.0.0.1</ip>
    <port>9339</port>
    <zone>simpleChat</zone>
    <debug>true</debug>
    <blueBoxIpAddress>127.0.0.1</blueBoxIpAddress>
    <blueBoxPort>9339</blueBoxPort>
    <smartConnect>true</smartConnect>
    <httpPort>8080</httpPort>
    <httpPollSpeed>750</httpPollSpeed>
    <rawProtocolSeparator>%</rawProtocolSeparator>
</SmartFoxClient>

• Dispatched when the external SmartFoxClient configuration file has been loaded successfully.

• Dispatched when an error occurs while loading the external SmartFoxClient configuration file.

smartFox.addEventListener(SFSEvent.onConfigLoadSuccess, onConfigLoadSuccessHandler)
smartFox.addEventListener(SFSEvent.onConfigLoadFailure, onConfigLoadFailureHandler)

smartFox.loadConfig("testEnvironmentConfig.xml", false)

function onConfigLoadSuccessHandler(evt:SFSEvent):void
{
    trace("Config file loaded, now connecting...")
    smartFox.connect(smartFox.ipAddress, smartFox.port)
}

function onConfigLoadFailureHandler(evt:SFSEvent):void
{
    trace("Failed loading config file: " + evt.params.message)
}

• Dispatched when the login to a SmartFoxServer zone has been attempted.

smartFox.addEventListener(SFSEvent.onLogin, onLoginHandler)

smartFox.login("simpleChat", "jack")

function onLoginHandler(evt:SFSEvent):void
{
    if (evt.params.success)
        trace("Successfully logged in as " + evt.params.name)
    else
        trace("Zone login error; the following error occurred: " + evt.params.error)
}

• Dispatched when the user logs out successfully.

smartFox.addEventListener(SFSEvent.onLogout, onLogoutHandler)

smartFox.logout()

function onLogoutHandler(evt:SFSEvent):void
{
    trace("Logged out successfully")
}

• Dispatched when the buddy list for the current user is received or a buddy is added/removed.

var buddyName:String = "jack"
smartFox.removeBuddy(buddyName)

• Dispatched when a response to the roundTripBench request is received.

smartFox.addEventListener(SFSEvent.onRoundTripResponse, onRoundTripResponseHandler)

var totalPingTime:Number = 0
var pingCount:int = 0

smartFox.roundTripBench() // TODO: this method must be called repeatedly every 3-5 seconds to have a significant average value

function onRoundTripResponseHandler(evt:SFSEvent):void
{
    var time:int = evt.params.elapsed

    // We assume that it takes the same time to the ping message to go from the client to the server
    // and from the server back to the client, so we divide the elapsed time by 2.
    totalPingTime += time / 2
    pingCount++

    var avg:int = Math.round(totalPingTime / pingCount)

    trace("Average lag: " + avg + " milliseconds")
}

smartFox.addEventListener(SFSEvent.onBuddyPermissionRequest, onBuddyPermissionRequestHandler)

var autoGrantPermission:Boolean = true

function onBuddyPermissionRequestHandler(evt:SFSEvent):void
{
    if (autoGrantPermission)
    {
        // Automatically grant permission

        smartFox.sendBuddyPermissionResponse(true, evt.params.sender)
    }
    else
    {
        // Display a custom alert containing grant/refuse buttons

        var alert_mc:CustomAlertPanel = new CustomAlertPanel()

        alert_mc.name_lb.text = evt.params.sender
        alert_mc.message_lb.text = evt.params.message

        // Display alert
        addChild(alert_mc)
    }
}

• Dispatched when a message from a Moderator is received.

smartFox.sendModeratorMessage("Greetings from the Moderator", SmartFoxClient.MODMSG_TO_ROOM, smartFox.getActiveRoom())

• Dispatched when an Actionscript object is received.

var move:Object = new Object()
move.x = 150
move.y = 250
move.speed = 8

smartFox.sendObject(move)

var itemsFound:Object = new Object()
itemsFound.jewels = ["necklace", "ring"]
itemsFound.weapons = ["sword", "sledgehammer"]

smartFox.sendObject(itemsFound)

• Dispatched when an Actionscript object is received.

var move:Object = new Object()
move.x = 150
move.y = 250
move.speed = 8

smartFox.sendObjectToGroup(move, [11, 12])

• Dispatched when a private chat message is received.

smartFox.addEventListener(SFSEvent.onPrivateMessage, onPrivateMessageHandler)

smartFox.sendPrivateMessage("Hallo Jack!", 22)

function onPrivateMessageHandler(evt:SFSEvent):void
{
    trace("User " + evt.params.sender.getName() + " sent the following private message: " + evt.params.message)
}

• Dispatched when a public chat message is received.

smartFox.addEventListener(SFSEvent.onPublicMessage, onPublicMessageHandler)

smartFox.sendPublicMessage("Hello world!")

function onPublicMessageHandler(evt:SFSEvent):void
{
    trace("User " + evt.params.sender.getName() + " said: " + evt.params.message)
}

// A bullet is being fired
var params:Object = new Object()
params.type = "bullet"
params.posx = 100
params.posy = 200
params.speed = 10
params.angle = 45

// Invoke "fire" command on the extension called "gameExt", using JSON protocol
smartFox.sendXtMessage("gameExt", "fire", params, SmartFoxClient.XTMSG_TYPE_JSON)

smartFox.setBuddyBlockStatus("jack", true)

• Dispatched when the status or variables of a buddy in the buddy list change.

var bVars:Object = new Object()
bVars["status"] = "away"
bVars["track"] = "One Of These Days"
bVars["$rank"] = "guru"

smartFox.setBuddyVariables(bVars)

• Dispatched when Room Variables are updated.

var rVars:Array = new Array()
rVars.push({name:"score", val:2500, persistent:true})

smartFox.setRoomVariables(rVars)

var rVars:Array = new Array()
rVars.push({name:"bestTime", val:100, priv:true})
rVars.push({name:"bestLap", val:120})

smartFox.setRoomVariables(rVars)

var rVars:Array = new Array()
rVars.push({name:"bestTime", val:null})

smartFox.setRoomVariables(rVars)

var rVars:Array = new Array()
var names:Array = ["john", "dave", "sam"]

for (var i:int = 0; i < names.length; i++)
    rVars.push({name:"name" + i, val:names[i]})

smartFox.setRoomVariables(rVars)

smartFox.addEventListener(SFSEvent.onRoomVariablesUpdate, onRoomVariablesUpdateHandler)

function onRoomVariablesUpdateHandler(evt:SFSEvent):void
{
    var changedVars:Array = evt.params.changedVars

    // Iterate on the 'changedVars' array to check which variables were updated
    for (var v:String in changedVars)
        trace(v + " room variable was updated; new value is: " + evt.params.room.getVariable(v))
}

// For example, a variable that is defined in the server-side xml configuration file is owned by the Server itself;
// if it's not set to private, its owner will change as soon as a user updates it.
// To avoid this change of ownership the setOwnership flag is set to false.
var rVars:Array = new Array()
rVars.push({name:"shipPosX", val:100})
rVars.push({name:"shipPosY", val:200})

smartFox.setRoomVariables(rVars, smartFox.getActiveRoom(), false)

• Dispatched when a user in the current room updates his/her User Variables.

var uVars:Object = new Object()
uVars.myAvatar = "Homer"
uVars.posx = 100
uVars.posy = 200

smartFox.setUserVariables(uVars)

• Dispatched in response to the switchPlayer request.

smartFox.addEventListener(SFSEvent.onPlayerSwitched, onPlayerSwitchedHandler)

smartFox.switchPlayer()

function onPlayerSwitchedHandler(evt:SFSEvent):void
{
    if (evt.params.success)
        trace("You have been turned into a spectator; your id is: " + evt.params.newId)
    else
        trace("The attempt to switch from player to spectator failed!")
}

• Dispatched in response to the switchSpectator request.

smartFox.addEventListener(SFSEvent.onSpectatorSwitched, onSpectatorSwitchedHandler)

smartFox.switchSpectator()

function onSpectatorSwitchedHandler(evt:SFSEvent):void
{
    if (evt.params.success)
        trace("You have been turned into a player; your player id is " + evt.params.newId)
    else
        trace("The attempt to switch from spectator to player failed")
}