Documentation for classes includes syntax, usage information, and code samples for methods, properties, and event handlers and listeners for those APIs that belong to a specific class in ActionScript. The classes are listed alphabetically. If you are not sure to which class a certain method or property belongs, you can look it up in the Index.


 ClassPackageDescription
 AddBuddiesRequest
com.electrotank.electroserver5.api This request adds an array of users to your buddy list.
 AddBuddiesResponse
com.electrotank.electroserver5.api This is a response to an AddBuddiesRequest, detailing for each user listed in the request whether the user was added as a buddy or not.
 AddRoomOperatorRequest
com.electrotank.electroserver5.api This request can be made by a current room operator to give operator status to another user in the room.
 AggregatePluginMessageEvent
com.electrotank.electroserver5.api Most games have a server plugin that contains custom game logic.
 AggregatePluginRequest
com.electrotank.electroserver5.api Most games are event driven, and they communicate with the server when an important event happens on the client.
 AvailableConnection
com.electrotank.electroserver5.connection This class holds the information needed to make a new connection.
 Base64Decoder
com.electrotank.electroserver5.util A utility class to decode a Base64 encoded String to a ByteArray.
 Base64Encoder
com.electrotank.electroserver5.util A utility class to encode a String or ByteArray as a Base64 encoded String.
 BuddyStatusUpdateAction
com.electrotank.electroserver5.api 
 BuddyStatusUpdateEvent
com.electrotank.electroserver5.api A buddy is either logged in or not.
 ClientType
com.electrotank.electroserver5.util 
 Connection
com.electrotank.electroserver5.connection This is the base class for all connections.
 ConnectionAttemptResponse
com.electrotank.electroserver5.api Before a client can do anything with the server a connection must be established.
 ConnectionClosedEvent
com.electrotank.electroserver5.api When a connection closes this event occurs.
 ConnectionResponse
com.electrotank.electroserver5.api Before a client can do anything with the server a connection must be established.
 CreateOrJoinGameResponse
com.electrotank.electroserver5.api The QuickJoinGameRequest is used to create a new game on the server, or to join a game that matches the criteria passed in.
 CreateRoomRequest
com.electrotank.electroserver5.api This class represents a highly flexible server request.
 CreateRoomVariableRequest
com.electrotank.electroserver5.api This request creates a room variable.
 CrossDomainPolicyRequest
com.electrotank.electroserver5.api 
 CrossDomainPolicyResponse
com.electrotank.electroserver5.api 
 CryptoTools
com.electrotank.electroserver5.util 
 DataType
com.electrotank.electroserver5.api 
 DeleteRoomVariableRequest
com.electrotank.electroserver5.api This request deletes a room variable.
 DeleteUserVariableRequest
com.electrotank.electroserver5.api This request deletes a user variable.
 DhAesEncryptionContext
com.electrotank.electroserver5.util 
 DHInitiateKeyExchangeRequest
com.electrotank.electroserver5.api 
 DHPublicNumbersResponse
com.electrotank.electroserver5.api 
 DHSharedModulusRequest
com.electrotank.electroserver5.api 
 DHSharedModulusResponse
com.electrotank.electroserver5.api 
 ElectroServer
com.electrotank.electroserver5 This class is used as an entry point for a 2nd level convenient API.
 EncryptionStateChangeEvent
com.electrotank.electroserver5.api Event fired when the encryption state of a client changes.
 ErrorType
com.electrotank.electroserver5.api 
 ES5TraceAdapter
com.electrotank.electroserver5.util 
 ES5TraceLogger
com.electrotank.electroserver5.util 
 ESEngine
com.electrotank.electroserver5.connection This class represents the lowest level API.
 EsEntity
com.electrotank.electroserver5.api 
 EsEvent
com.electrotank.electroserver5.api 
 EsMessage
com.electrotank.electroserver5.api 
 EsObject
com.electrotank.electroserver5.api This class is used to represent an EsObject.
 EsObjectCodec
com.electrotank.electroserver5.api 
 EsObjectDataHolder
com.electrotank.electroserver5.api This class is used internally by the EsObject class.
 EsObjectMap
com.electrotank.electroserver5.api This class is used internally to map a name to an EsObject value..
 EsObjectRO
com.electrotank.electroserver5.api This interface is used to define what is readable off of an EsObject.
 EsRequest
com.electrotank.electroserver5.api 
 EsResponse
com.electrotank.electroserver5.api 
 EsUtility
com.electrotank.electroserver5.api 
 EvictUserFromRoomRequest
com.electrotank.electroserver5.api By default, the first client joined to a room is the room operator.
 FindGamesRequest
com.electrotank.electroserver5.api This request allows a client to request a list of games that are managed by the server.
 FindGamesResponse
com.electrotank.electroserver5.api The FindGamesRequest allows a client to request a list of games that are managed by the server.
 FindZoneAndRoomByNameRequest
com.electrotank.electroserver5.api Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone.
 FindZoneAndRoomByNameResponse
com.electrotank.electroserver5.api Knowing the name of a room and the name of a zone you can request the id of the room and the id of the zone.
 FlattenedEsObject
com.electrotank.electroserver5.api 
 FlattenedEsObjectRO
com.electrotank.electroserver5.api 
 FlexAdapter
com.electrotank.logging.adapter 
 FlexLogger
com.electrotank.logging.adapter 
 GatewayKickUserRequest
com.electrotank.electroserver5.api 
 GenericErrorResponse
com.electrotank.electroserver5.api When the client sends a request that request can lead to a server error, or just a failure.
 GetGameTypesRequest
com.electrotank.electroserver5.api This request asks the server for a list of registered gametypes.
 GetGameTypesResponse
com.electrotank.electroserver5.api When a client sends a GetGameTypesRequest it leads to this response, which contains a list of all gameTypes currently registered with GameManager.
 GetRoomsInZoneRequest
com.electrotank.electroserver5.api This request allows the client to ask for a list of all of the rooms in a specific zone.
 GetRoomsInZoneResponse
com.electrotank.electroserver5.api This the response to the GetRoomsInZoneRequest.
 GetServerLocalTimeRequest
com.electrotank.electroserver5.api Requests a timestamp from the server.
 GetServerLocalTimeResponse
com.electrotank.electroserver5.api Response to a GetServerLocalTimeRequest.
 GetUserCountRequest
com.electrotank.electroserver5.api This request asks the server for the current number of users logged in.
 GetUserCountResponse
com.electrotank.electroserver5.api This is the response to the GetUserCountRequest.
 GetUsersInRoomRequest
com.electrotank.electroserver5.api This request allows a client to load the list of users in any room.
 GetUsersInRoomResponse
com.electrotank.electroserver5.api This is the response to the GetUsersInRoomRequest.
 GetUserVariablesRequest
com.electrotank.electroserver5.api Loads a list of user variables for the specified userName.
 GetUserVariablesResponse
com.electrotank.electroserver5.api GetUserVariablesRequest loads a list of user variables for the specified userName, and this class is the response.
 GetZonesRequest
com.electrotank.electroserver5.api This request get the list of zones on the server.
 GetZonesResponse
com.electrotank.electroserver5.api When a client sends a GetZonesRequest it leads to this response.
 HttpConnection
com.electrotank.electroserver5.connection This class handles creating and using a connection to ElectroServer over HTTP.
 IdleTimeoutWarningEvent
com.electrotank.electroserver5.api When a user is in danger of being kicked from the server due to idleness, this event occurs.
 ILogAdapter
com.electrotank.logging.adapter 
 ILogger
com.electrotank.logging.adapter 
 JoinGameRequest
com.electrotank.electroserver5.api 
 JoinRoomEvent
com.electrotank.electroserver5.api When a user is joined successfully to a room this event occurs.
 JoinRoomRequest
com.electrotank.electroserver5.api If you know that a specific room already exists, then you can join it using this request.
 JoinZoneEvent
com.electrotank.electroserver5.api A zone is a collection of rooms.
 LeaveRoomEvent
com.electrotank.electroserver5.api When a user leaves a room this event occurs.
 LeaveRoomRequest
com.electrotank.electroserver5.api When a user wants to leave a room it can be done via this request.
 LeaveZoneEvent
com.electrotank.electroserver5.api When a user leaves all rooms in a zone this event occurs.
 Log
com.electrotank.logging.adapter This Log class is simply a proxy for the true Logging system.
 LoginRequest
com.electrotank.electroserver5.api This message is sent by the client to the server (after establishing a connection) to attempt to login.
 LoginResponse
com.electrotank.electroserver5.api After a client attempts a login via the LoginRequest message the server responds with this message.
 LogOutRequest
com.electrotank.electroserver5.api 
 LogUtil
com.electrotank.utils This class contains static methods which can be used to perform common logging tasks.
 ManagerHelper
com.electrotank.electroserver5 This class listens for many ElectroServer events so that it can manage the state of some useful things for you to conveniently access.
 MessageReader
com.electrotank.electroserver5.api 
 MessageType
com.electrotank.electroserver5.api 
 MessageWriter
com.electrotank.electroserver5.api 
 NoopAdapter
com.electrotank.logging.adapter 
 NoopLogger
com.electrotank.logging.adapter 
 PingRequest
com.electrotank.electroserver5.api 
 PingResponse
com.electrotank.electroserver5.api 
 PluginListEntry
com.electrotank.electroserver5.api 
 PluginMessageEvent
com.electrotank.electroserver5.api This even occurs when a message from a plugin is received.
 PluginRequest
com.electrotank.electroserver5.api This class is used to send a message to a plugin.
 PrivateMessageEvent
com.electrotank.electroserver5.api This event occurs when a client receives a private message from another user.
 PrivateMessageRequest
com.electrotank.electroserver5.api This request is used to send private messages to one or more users at once.
 Protocol
com.electrotank.electroserver5.api 
 ProtocolConfiguration
com.electrotank.electroserver5.api 
 PublicMessageEvent
com.electrotank.electroserver5.api This event occurs when a public message is sent to a room to which the client belongs.
 PublicMessageRequest
com.electrotank.electroserver5.api This class is used to send a public message to a room that the user is in.
 QueuedMessage
com.electrotank.electroserver5.connection This class is used in one of two ways: 1) stores a client-bound message that was received a little bit too early, to be processed later.
 QuickJoinGameRequest
com.electrotank.electroserver5.api This request is used to create a new game on the server, or to join a game that matches the criteria passed in.
 RegisterUDPConnectionRequest
com.electrotank.electroserver5.api 
 RegisterUDPConnectionResponse
com.electrotank.electroserver5.api 
 RegistryConnectToPreferredGatewayRequest
com.electrotank.electroserver5.api 
 RemoveBuddiesRequest
com.electrotank.electroserver5.api This request removes a user from a client's buddy list.
 RemoveBuddiesResponse
com.electrotank.electroserver5.api This is a response to a RemoveBuddiesRequest, detailing for each user listed in the request whether the user was removed as a buddy or not.
 RemoveRoomOperatorRequest
com.electrotank.electroserver5.api This request can be made by a current room operator to remove operator status from another user in the room.
 RemoveUDPConnectionRequest
com.electrotank.electroserver5.api 
 RemoveUDPConnectionResponse
com.electrotank.electroserver5.api 
 RequestDetails
com.electrotank.electroserver5.api 
 Room
com.electrotank.electroserver5.zone This class represents a room on the server.
 RoomListEntry
com.electrotank.electroserver5.api 
 RoomVariable
com.electrotank.electroserver5.api 
 RoomVariableUpdateAction
com.electrotank.electroserver5.api 
 RoomVariableUpdateEvent
com.electrotank.electroserver5.api When a room variable is created, deleted, or updated in a room that the client belongs to then this event occurs.
 RtmpConnection
com.electrotank.electroserver5.connection This class handles connecting to ElectroServer via RTMP connection, for audio and video streaming.
 SearchCriteria
com.electrotank.electroserver5.api 
 Server
com.electrotank.electroserver5.server This class is used to represent a server that can and may be connected to by the client.
 ServerGame
com.electrotank.electroserver5.api 
 ServerKickUserEvent
com.electrotank.electroserver5.api When a user is kicked from the server, this event occurs.
 SessionIdleEvent
com.electrotank.electroserver5.api This event occurs if the client has been idle (not sending any messages to the server) for an amount of time that is equal to or greater than the maximum time allowed for idling.
 SettingsXMLParser
com.electrotank.electroserver5.util This class is a utility used to parse a standard formatted server settings file.
 SocketConnection
com.electrotank.electroserver5.connection This class connects to ElectroServer via Socket.
 ThriftAddBuddiesRequest
com.electrotank.electroserver5.thrift 
 ThriftAddBuddiesResponse
com.electrotank.electroserver5.thrift 
 ThriftAddRoomOperatorRequest
com.electrotank.electroserver5.thrift 
 ThriftAggregatePluginMessageEvent
com.electrotank.electroserver5.thrift 
 ThriftAggregatePluginRequest
com.electrotank.electroserver5.thrift 
 ThriftBuddyStatusUpdateAction
com.electrotank.electroserver5.thrift 
 ThriftBuddyStatusUpdateEvent
com.electrotank.electroserver5.thrift 
 ThriftConnectionAttemptResponse
com.electrotank.electroserver5.thrift 
 ThriftConnectionClosedEvent
com.electrotank.electroserver5.thrift 
 ThriftConnectionResponse
com.electrotank.electroserver5.thrift 
 ThriftCreateOrJoinGameResponse
com.electrotank.electroserver5.thrift 
 ThriftCreateRoomRequest
com.electrotank.electroserver5.thrift 
 ThriftCreateRoomVariableRequest
com.electrotank.electroserver5.thrift 
 ThriftCrossDomainPolicyRequest
com.electrotank.electroserver5.thrift 
 ThriftCrossDomainPolicyResponse
com.electrotank.electroserver5.thrift 
 ThriftDeleteRoomVariableRequest
com.electrotank.electroserver5.thrift 
 ThriftDeleteUserVariableRequest
com.electrotank.electroserver5.thrift 
 ThriftDHInitiateKeyExchangeRequest
com.electrotank.electroserver5.thrift 
 ThriftDHPublicNumbersResponse
com.electrotank.electroserver5.thrift 
 ThriftDHSharedModulusRequest
com.electrotank.electroserver5.thrift 
 ThriftDHSharedModulusResponse
com.electrotank.electroserver5.thrift 
 ThriftEncryptionStateChangeEvent
com.electrotank.electroserver5.thrift 
 ThriftErrorType
com.electrotank.electroserver5.thrift 
 ThriftEvictUserFromRoomRequest
com.electrotank.electroserver5.thrift 
 ThriftFindGamesRequest
com.electrotank.electroserver5.thrift 
 ThriftFindGamesResponse
com.electrotank.electroserver5.thrift 
 ThriftFindZoneAndRoomByNameRequest
com.electrotank.electroserver5.thrift 
 ThriftFindZoneAndRoomByNameResponse
com.electrotank.electroserver5.thrift 
 ThriftFlattenedEsObject
com.electrotank.electroserver5.thrift 
 ThriftFlattenedEsObjectRO
com.electrotank.electroserver5.thrift 
 ThriftGatewayKickUserRequest
com.electrotank.electroserver5.thrift 
 ThriftGenericErrorResponse
com.electrotank.electroserver5.thrift 
 ThriftGetGameTypesRequest
com.electrotank.electroserver5.thrift 
 ThriftGetGameTypesResponse
com.electrotank.electroserver5.thrift 
 ThriftGetRoomsInZoneRequest
com.electrotank.electroserver5.thrift 
 ThriftGetRoomsInZoneResponse
com.electrotank.electroserver5.thrift 
 ThriftGetServerLocalTimeRequest
com.electrotank.electroserver5.thrift 
 ThriftGetServerLocalTimeResponse
com.electrotank.electroserver5.thrift 
 ThriftGetUserCountRequest
com.electrotank.electroserver5.thrift 
 ThriftGetUserCountResponse
com.electrotank.electroserver5.thrift 
 ThriftGetUsersInRoomRequest
com.electrotank.electroserver5.thrift 
 ThriftGetUsersInRoomResponse
com.electrotank.electroserver5.thrift 
 ThriftGetUserVariablesRequest
com.electrotank.electroserver5.thrift 
 ThriftGetUserVariablesResponse
com.electrotank.electroserver5.thrift 
 ThriftGetZonesRequest
com.electrotank.electroserver5.thrift 
 ThriftGetZonesResponse
com.electrotank.electroserver5.thrift 
 ThriftIdleTimeoutWarningEvent
com.electrotank.electroserver5.thrift 
 ThriftJoinGameRequest
com.electrotank.electroserver5.thrift 
 ThriftJoinRoomEvent
com.electrotank.electroserver5.thrift 
 ThriftJoinRoomRequest
com.electrotank.electroserver5.thrift 
 ThriftJoinZoneEvent
com.electrotank.electroserver5.thrift 
 ThriftLeaveRoomEvent
com.electrotank.electroserver5.thrift 
 ThriftLeaveRoomRequest
com.electrotank.electroserver5.thrift 
 ThriftLeaveZoneEvent
com.electrotank.electroserver5.thrift 
 ThriftLoginRequest
com.electrotank.electroserver5.thrift 
 ThriftLoginResponse
com.electrotank.electroserver5.thrift 
 ThriftLogOutRequest
com.electrotank.electroserver5.thrift 
 ThriftMessageType
com.electrotank.electroserver5.thrift 
 ThriftPingRequest
com.electrotank.electroserver5.thrift 
 ThriftPingResponse
com.electrotank.electroserver5.thrift 
 ThriftPluginListEntry
com.electrotank.electroserver5.thrift 
 ThriftPluginMessageEvent
com.electrotank.electroserver5.thrift 
 ThriftPluginRequest
com.electrotank.electroserver5.thrift 
 ThriftPrivateMessageEvent
com.electrotank.electroserver5.thrift 
 ThriftPrivateMessageRequest
com.electrotank.electroserver5.thrift 
 ThriftProtocol
com.electrotank.electroserver5.thrift 
 ThriftProtocolConfiguration
com.electrotank.electroserver5.thrift 
 ThriftPublicMessageEvent
com.electrotank.electroserver5.thrift 
 ThriftPublicMessageRequest
com.electrotank.electroserver5.thrift 
 ThriftQuickJoinGameRequest
com.electrotank.electroserver5.thrift 
 ThriftRegisterUDPConnectionRequest
com.electrotank.electroserver5.thrift 
 ThriftRegisterUDPConnectionResponse
com.electrotank.electroserver5.thrift 
 ThriftRegistryConnectToPreferredGatewayRequest
com.electrotank.electroserver5.thrift 
 ThriftRemoveBuddiesRequest
com.electrotank.electroserver5.thrift 
 ThriftRemoveBuddiesResponse
com.electrotank.electroserver5.thrift 
 ThriftRemoveRoomOperatorRequest
com.electrotank.electroserver5.thrift 
 ThriftRemoveUDPConnectionRequest
com.electrotank.electroserver5.thrift 
 ThriftRemoveUDPConnectionResponse
com.electrotank.electroserver5.thrift 
 ThriftRequestDetails
com.electrotank.electroserver5.thrift 
 ThriftRoomListEntry
com.electrotank.electroserver5.thrift 
 ThriftRoomVariable
com.electrotank.electroserver5.thrift 
 ThriftRoomVariableUpdateAction
com.electrotank.electroserver5.thrift 
 ThriftRoomVariableUpdateEvent
com.electrotank.electroserver5.thrift 
 ThriftSearchCriteria
com.electrotank.electroserver5.thrift 
 ThriftSerializable
com.electrotank.electroserver5.api 
 ThriftServerGame
com.electrotank.electroserver5.thrift 
 ThriftServerKickUserEvent
com.electrotank.electroserver5.thrift 
 ThriftSessionIdleEvent
com.electrotank.electroserver5.thrift 
 ThriftUpdateRoomDetailsEvent
com.electrotank.electroserver5.thrift 
 ThriftUpdateRoomDetailsRequest
com.electrotank.electroserver5.thrift 
 ThriftUpdateRoomVariableRequest
com.electrotank.electroserver5.thrift 
 ThriftUpdateUserVariableRequest
com.electrotank.electroserver5.thrift 
 ThriftUserEvictedFromRoomEvent
com.electrotank.electroserver5.thrift 
 ThriftUserListEntry
com.electrotank.electroserver5.thrift 
 ThriftUserUpdateAction
com.electrotank.electroserver5.thrift 
 ThriftUserUpdateEvent
com.electrotank.electroserver5.thrift 
 ThriftUserVariable
com.electrotank.electroserver5.thrift 
 ThriftUserVariableUpdateAction
com.electrotank.electroserver5.thrift 
 ThriftUserVariableUpdateEvent
com.electrotank.electroserver5.thrift 
 ThriftUtil
com.electrotank.electroserver5.api 
 ThriftValidateAdditionalLoginRequest
com.electrotank.electroserver5.thrift 
 ThriftValidateAdditionalLoginResponse
com.electrotank.electroserver5.thrift 
 ThriftZoneListEntry
com.electrotank.electroserver5.thrift 
 ThriftZoneUpdateAction
com.electrotank.electroserver5.thrift 
 ThriftZoneUpdateEvent
com.electrotank.electroserver5.thrift 
 TraceAdapter
com.electrotank.logging.adapter 
 TraceLogger
com.electrotank.logging.adapter 
 TransportType
com.electrotank.electroserver5.connection This class contains string values for each type of connection that can be established.
 UdpConnection
com.electrotank.electroserver5.connection This class allows the client to communicate with ElectroServer using UDP.
 UpdateRoomDetailsEvent
com.electrotank.electroserver5.api Certain properties of a room can be updated by a user in that room after the room has been created.
 UpdateRoomDetailsRequest
com.electrotank.electroserver5.api Certain properties of a room can be updated by a user in that room after the room has been created.
 UpdateRoomVariableRequest
com.electrotank.electroserver5.api 
 UpdateUserVariableRequest
com.electrotank.electroserver5.api This request creates or updates a user variable.
 User
com.electrotank.electroserver5.user This class represents a user on the server.
 UserEvictedFromRoomEvent
com.electrotank.electroserver5.api By default, the first client joined to a room is the room operator.
 UserListEntry
com.electrotank.electroserver5.api 
 UserManager
com.electrotank.electroserver5.user This class keeps track of all users that you should know about.
 UserUpdateAction
com.electrotank.electroserver5.api 
 UserUpdateEvent
com.electrotank.electroserver5.api The user list can change when a client is in a room, and properties on a user can also change.
 UserVariable
com.electrotank.electroserver5.api 
 UserVariableUpdateAction
com.electrotank.electroserver5.api 
 UserVariableUpdateEvent
com.electrotank.electroserver5.api This event occurs whenever a user variable is created, updated, or removed.
 ValidateAdditionalLoginRequest
com.electrotank.electroserver5.api This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer.
 ValidateAdditionalLoginResponse
com.electrotank.electroserver5.api This request and the ValidateAdditionalLoginResponse messages are ones that you will not have to worry about as a developer.
 Zone
com.electrotank.electroserver5.zone This class represents a zone on the server.
 ZoneListEntry
com.electrotank.electroserver5.api 
 ZoneManager
com.electrotank.electroserver5.zone This class manages the list of zones that you should know about based on the rooms that you are in.
 ZoneUpdateAction
com.electrotank.electroserver5.api 
 ZoneUpdateEvent
com.electrotank.electroserver5.api This event occurs when the room list changes in a zone that your client can see, or when a public property on a room in that zone changes.