Variables

_es

private var _es: ElectroServer

_ip

private var _ip: String

_port

private var _port: Number

_username

private var _username: String

_password

private var _password: String

_defaultZoneName

private var _defaultZoneName: String

_defaultRoomName

private var _defaultRoomName: String

_isModerator

private var _isModerator: Boolean

_users_arr

private var _users_arr: Array

_zoneManager

private var _zoneManager: ZoneManager

_currentRoom

private var _currentRoom: Room

_myCS

private var _myCS: CharacterSettings

TAG_CHARACTER_CORRECTION

private var TAG_CHARACTER_CORRECTION: String

TAG_CHARACTER_CORRECTION_CAUSE

private var TAG_CHARACTER_CORRECTION_CAUSE: String

TAG_CHARACTER_CORRECTION_VICTIM

private var TAG_CHARACTER_CORRECTION_VICTIM: String

TAG_SENDER_ID

private var TAG_SENDER_ID: String

TAG_IS_MODERATOR

private var TAG_IS_MODERATOR: String

TAG_IS_BANNED

private var TAG_IS_BANNED: String

MODERATOR_PLUGIN

private var MODERATOR_PLUGIN: String

TAG_REQUEST_NAME

private var TAG_REQUEST_NAME: String

Functions

ServerES

public function ServerES()

socketSetup

private function socketSetup():Void

dispatchEvent

public function dispatchEvent():Void

addEventListener

public function addEventListener():Void

removeEventListener

public function removeEventListener():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(username: String,
password: String):Void

createRoom

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

joinRoom

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

leaveCurrentRoom

private function leaveCurrentRoom():Void

characterCorrection

public function characterCorrection(character: CharacterSettings,
cause: MapObjectSettings):Void

removeCharacterCorrectionVariables

private function removeCharacterCorrectionVariables():Void

getUserList

public function getUserList(without_me: Boolean):Array

getRoomList

public function getRoomList():Array

getActiveRoom

public function getActiveRoom():TheoRoomData

setUserVariable

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

setUserVariables

public function setUserVariables(cs: CharacterSettings):Void

sendPublicMessage

public function sendPublicMessage(text: String):Void

sendPrivateMessage

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

sendMove

public function sendMove(cs: CharacterSettings):Void

close

public function close():Void

kick

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

ban

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

getMyLatency

public function getMyLatency():Number

getMyUserID

public function getMyUserID():String

isConnected

public function isConnected():Boolean

getDefaultRoomName

public function getDefaultRoomName():String

isModerator

public function isModerator(userID: String):Boolean

onConnection

private function onConnection(e: ConnectionEvent):Void

onConnectionLost

private function onConnectionLost():Void

onLogin

private function onLogin(e: LoginResponse):Void

onLogout

private function onLogout():Void

onJoinZone

private function onJoinZone(e: JoinZoneEvent):Void

onZoneUpdate

private function onZoneUpdate(e: ZoneUpdateEvent):Void

onJoinRoom

private function onJoinRoom(e: JoinRoomEvent):Void

onRoomListUpdate

private function onRoomListUpdate():Void

onRoomVariableUpdate

private function onRoomVariableUpdate(e: RoomVariableUpdateEvent):Void

onUserListUpdateEvent

private function onUserListUpdateEvent(e: UserListUpdateEvent):Void

onUserEnterRoom

private function onUserEnterRoom(user: User):Void

onUserLeaveRoom

private function onUserLeaveRoom(user: User):Void

onUserVariablesUpdate

private function onUserVariablesUpdate(e: UserVariableUpdateEvent):Void

onPublicMessage

private function onPublicMessage(e: PublicMessageEvent):Void

onPrivateMessage

private function onPrivateMessage(e: PrivateMessageEvent):Void

onPluginMessage

private function onPluginMessage(e: PluginMessageEvent):Void

for MODERATOR_PLUGIN only now

onErrorResponse

private function onErrorResponse(e: GenericErrorResponse):Void

userEvictedFromRoom

private function userEvictedFromRoom(e: UserEvictedFromRoomEvent):Void

onModeratorMessage

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

getCurrentRoomVariable

private function getCurrentRoomVariable(nameVariable: String):EsObject

createUserList

private function createUserList():Void

getUserObjectWithID

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

Returns

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

iAmServer

private function iAmServer():Boolean

fromCharacterSettingsToEsObject

private function fromCharacterSettingsToEsObject(cs: CharacterSettings):EsObject

fromEsObjectToCharacterSettings

private function fromEsObjectToCharacterSettings(
   esObject: EsObject
):CharacterSettings
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
private var _es: ElectroServer
private var _ip: String
private var _port: Number
private var _username: String
private var _password: String
private var _defaultZoneName: String
private var _defaultRoomName: String
private var _isModerator: Boolean
private var _users_arr: Array
private var _zoneManager: ZoneManager
private var _currentRoom: Room
private var _myCS: CharacterSettings
private var TAG_CHARACTER_CORRECTION: String
private var TAG_CHARACTER_CORRECTION_CAUSE: String
private var TAG_CHARACTER_CORRECTION_VICTIM: String
private var TAG_SENDER_ID: String
private var TAG_IS_MODERATOR: String
private var TAG_IS_BANNED: String
private var MODERATOR_PLUGIN: String
private var TAG_REQUEST_NAME: String
public function ServerES()
private function socketSetup():Void
public function dispatchEvent():Void
public function addEventListener():Void
public function removeEventListener():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(username: String,
password: String):Void
public function createRoom(roomName: String,
auto_join: Boolean):Void
public function joinRoom(room, 
password: String):Void
private function leaveCurrentRoom():Void
public function characterCorrection(character: CharacterSettings,
cause: MapObjectSettings):Void
private function removeCharacterCorrectionVariables():Void
public function getUserList(without_me: Boolean):Array
public function getRoomList():Array
public function getActiveRoom():TheoRoomData
public function setUserVariable(name: String,
value: String):Void
public function setUserVariables(cs: CharacterSettings):Void
public function sendPublicMessage(text: String):Void
public function sendPrivateMessage(text: String,
recipientId: String):Void
public function sendMove(cs: CharacterSettings):Void
public function close():Void
public function kick(userNetID: String,
reason: String):Void
public function ban(userNetID: String,
reason: String,
time: Number):Void
public function getMyLatency():Number
public function getMyUserID():String
public function isConnected():Boolean
public function getDefaultRoomName():String
public function isModerator(userID: String):Boolean
private function onConnection(e: ConnectionEvent):Void
private function onConnectionLost():Void
private function onLogin(e: LoginResponse):Void
private function onLogout():Void
private function onJoinZone(e: JoinZoneEvent):Void
private function onZoneUpdate(e: ZoneUpdateEvent):Void
private function onJoinRoom(e: JoinRoomEvent):Void
private function onRoomListUpdate():Void
private function onRoomVariableUpdate(e: RoomVariableUpdateEvent):Void
private function onUserListUpdateEvent(e: UserListUpdateEvent):Void
private function onUserEnterRoom(user: User):Void
private function onUserLeaveRoom(user: User):Void
private function onUserVariablesUpdate(e: UserVariableUpdateEvent):Void
private function onPublicMessage(e: PublicMessageEvent):Void
private function onPrivateMessage(e: PrivateMessageEvent):Void
private function onPluginMessage(e: PluginMessageEvent):Void
for MODERATOR_PLUGIN only now
private function onErrorResponse(e: GenericErrorResponse):Void
private function userEvictedFromRoom(e: UserEvictedFromRoomEvent):Void
private function onModeratorMessage(message: String,
sender: User,
showOnlyToHistory: Boolean):Void
private function getCurrentRoomVariable(nameVariable: String):EsObject
private function createUserList():Void
private function getUserObjectWithID(id: String,
remove: Boolean):Object
Object {cs:CharacterSettings, user:User, latency:Number}
private function iAmServer():Boolean
private function fromCharacterSettingsToEsObject(cs: CharacterSettings):EsObject
private function fromEsObjectToCharacterSettings(
   esObject: EsObject
):CharacterSettings
Close