Functions

dispatchEvent

function dispatchEvent():Void

addEventListener

function addEventListener():Void

removeEventListener

function removeEventListener():Void

Variables

LOBBY

private var LOBBY: String

_flagRoomListUpdated

private var _flagRoomListUpdated: Boolean

_flagCreatingTarget

private var _flagCreatingTarget: Boolean

_fox

private var _fox: SmartFoxClient

_ip

private var _ip: String

_port

private var _port: Number

_username

private var _username: String

_password

private var _password: String

_defaultZone

private var _defaultZone: String

_defaultRoomName

private var _defaultRoomName: String

_debug

private var _debug: Boolean

_targetRoomName

private var _targetRoomName: String

_roomXML

private var _roomXML: String

_myLatency

private var _myLatency: Number

_pingRoundTotalPingTime

private var _pingRoundTotalPingTime: Number

_pingRoundTripCount

private var _pingRoundTripCount: Number

_pingRoundTripInterval

private var _pingRoundTripInterval: Number

_pingRoundTripPeriod

private var _pingRoundTripPeriod: Number

_iAmServer

private var _iAmServer: Boolean

_users_arr

private var _users_arr: Array

Functions

ServerSF

function ServerSF()

characterCorrection

function characterCorrection(cs: CharacterSettings,
cause: MapObjectSettings):Void

connect

public function connect (ip: String,
port: Number):Void

setIP

public function setIP(ip: String):Void

setPort

public function setPort(port: Number):Void

setUserName

public function setUserName(name: String):Void

setPassword

public function setPassword(pass: String):Void

login

public function login(name: String,
pass: String):Void

createRoom

public function createRoom(roomName: String,
auto_join: Boolean):Void

joinRoom

public function joinRoom(room, 
pass: String):Void

setUserVariables

public function setUserVariables(cs: CharacterSettings):Void

setUserVariable

function setUserVariable(name: String,
value: String):Void

sendPrivateMessage

function sendPrivateMessage(text: String,
recipientId: String):Void

kick

function kick(userNetID: String,
reason: String):Void

ban

function ban(userNetID: String,
reason: String,
time: Number):Void

sendPublicMessage

function sendPublicMessage(text: String):Void

sendMove

function sendMove(cs: CharacterSettings):Void

close

function close():Void

getMyUserID

function getMyUserID():String

getUserList

function getUserList(without_me: Boolean):Array

Returns

<CharacterSettings>Array

getRoomList

function getRoomList():Array

Returns

<TheoRoomData>Array

getActiveRoom

function getActiveRoom():TheoRoomData

onConnection

private function onConnection(success: Boolean):Void

onConnectionLost

private function onConnectionLost():Void

onLogin

private function onLogin(response: Object):Void

Parameters

param success: Boolean - the login result: true if the login to the provided zone succeeded; false if login failed.
param name: String - the user’s actual username.
param error: String - the error message in case of login failure. 

onLogout

private function onLogout():Void

onJoinRoom

private function onJoinRoom(myRoom: Room):Void

onJoinRoomError

private function onJoinRoomError(error: String):Void

onUserEnterRoom

private function onUserEnterRoom(roomId: Number,
user: User):Void

onUserLeaveRoom

private function onUserLeaveRoom(roomId: Number,
userId: Number,
userName: String):Void

onUserCountChange

private function onUserCountChange(room: Room):Void

Parameters

param room: the Room object representing the room where the change occurred. 

fromUserVariablesToCharacterSettings

private function fromUserVariablesToCharacterSettings(
   user: User
):CharacterSettings

onPublicMessage

private function onPublicMessage(message: String,
sender: User,
roomId: Number):Void

onPrivateMessage

private function onPrivateMessage(message: String,
sender: User,
roomId: Number,
userId: Number):Void

onUserVariablesUpdate

private function onUserVariablesUpdate(user: User,
vars: Object):Void

onObjectReceived

private function onObjectReceived(o: Object,
sender: User):Void

onRoomListUpdate

private function onRoomListUpdate(roomList: Object):Void

onRoomVariablesUpdate

private function onRoomVariablesUpdate(room: Room,
changedVars: Array):Void

onAdminMessage

private function onAdminMessage(message: String,
showOnlyToHistory: Boolean):Void

onModeratorMessage

private function onModeratorMessage(message: String,
sender: User,
showOnlyToHistory: Boolean):Void

onCreateRoomError

private function onCreateRoomError(error: String):Void

onRoundTripResponse

private function onRoundTripResponse(elapsed: Number):Void

getMyLatency

public function getMyLatency():Number

isConnected

public function isConnected():Boolean

isModerator

public function isModerator(userID: String):Boolean

getDefaultRoomName

public function getDefaultRoomName():String

startRoundTripPing

private function startRoundTripPing():Void

stopRoundTripPing

private function stopRoundTripPing():Void

createUserList

private function createUserList():Void

getUserObjectWithID

private function getUserObjectWithID(id: Number,
remove: Boolean):Object

Returns

Object {cs:CharacterSettings, user:User, latency:Number}

checkClientServerRelationsAmongClients

private function checkClientServerRelationsAmongClients():Void
IServer interface - lists all the functions that a Server object should implement
Server class - the basic object to communicate with the socket server - to be extended by implementation for each type of server
function dispatchEvent():Void
function addEventListener():Void
function removeEventListener():Void
private var LOBBY: String
private var _flagRoomListUpdated: Boolean
private var _flagCreatingTarget: Boolean
private var _fox: SmartFoxClient
private var _ip: String
private var _port: Number
private var _username: String
private var _password: String
private var _defaultZone: String
private var _defaultRoomName: String
private var _debug: Boolean
private var _targetRoomName: String
private var _roomXML: String
private var _myLatency: Number
private var _pingRoundTotalPingTime: Number
private var _pingRoundTripCount: Number
private var _pingRoundTripInterval: Number
private var _pingRoundTripPeriod: Number
private var _iAmServer: Boolean
private var _users_arr: Array
function ServerSF()
function characterCorrection(cs: CharacterSettings,
cause: MapObjectSettings):Void
public function connect (ip: String,
port: Number):Void
public function setIP(ip: String):Void
public function setPort(port: Number):Void
public function setUserName(name: String):Void
public function setPassword(pass: String):Void
public function login(name: String,
pass: String):Void
public function createRoom(roomName: String,
auto_join: Boolean):Void
public function joinRoom(room, 
pass: String):Void
public function setUserVariables(cs: CharacterSettings):Void
function setUserVariable(name: String,
value: String):Void
function sendPrivateMessage(text: String,
recipientId: String):Void
function kick(userNetID: String,
reason: String):Void
function ban(userNetID: String,
reason: String,
time: Number):Void
function sendPublicMessage(text: String):Void
function sendMove(cs: CharacterSettings):Void
function close():Void
function getMyUserID():String
function getUserList(without_me: Boolean):Array
<CharacterSettings>Array
function getRoomList():Array
<TheoRoomData>Array
function getActiveRoom():TheoRoomData
private function onConnection(success: Boolean):Void
private function onConnectionLost():Void
private function onLogin(response: Object):Void
private function onLogout():Void
private function onJoinRoom(myRoom: Room):Void
private function onJoinRoomError(error: String):Void
private function onUserEnterRoom(roomId: Number,
user: User):Void
private function onUserLeaveRoom(roomId: Number,
userId: Number,
userName: String):Void
private function onUserCountChange(room: Room):Void
private function fromUserVariablesToCharacterSettings(
   user: User
):CharacterSettings
private function onPublicMessage(message: String,
sender: User,
roomId: Number):Void
private function onPrivateMessage(message: String,
sender: User,
roomId: Number,
userId: Number):Void
private function onUserVariablesUpdate(user: User,
vars: Object):Void
private function onObjectReceived(o: Object,
sender: User):Void
private function onRoomListUpdate(roomList: Object):Void
private function onRoomVariablesUpdate(room: Room,
changedVars: Array):Void
private function onAdminMessage(message: String,
showOnlyToHistory: Boolean):Void
private function onModeratorMessage(message: String,
sender: User,
showOnlyToHistory: Boolean):Void
private function onCreateRoomError(error: String):Void
private function onRoundTripResponse(elapsed: Number):Void
public function getMyLatency():Number
public function isConnected():Boolean
public function isModerator(userID: String):Boolean
public function getDefaultRoomName():String
private function startRoundTripPing():Void
private function stopRoundTripPing():Void
private function createUserList():Void
private function getUserObjectWithID(id: Number,
remove: Boolean):Object
Object {cs:CharacterSettings, user:User, latency:Number}
private function checkClientServerRelationsAmongClients():Void
Close