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
 AbstractConnection
com.electrotank.electroserver4.connection This class is used internally to the ElectroServer class.
 AddBuddyRequest
com.electrotank.electroserver4.message.request Use the ElectroServer.addBuddy method to add a new buddy.
 AddBuddyRequestCodec
com.electrotank.electroserver4.protocol.codec 
 AddRoomOperatorRequest
com.electrotank.electroserver4.message.request This request is used for one room operator to request that another user in the room be granted operator privelages.
 AddRoomOperatorRequestCodec
com.electrotank.electroserver4.protocol.codec 
 As2ProtocolHandler
com.electrotank.electroserver4.protocol 
 BinaryMessageReader
com.electrotank.electroserver4.protocol.binary 
 BinaryMessageWriter
com.electrotank.electroserver4.protocol.binary 
 BuddyStatusUpdatedEvent
com.electrotank.electroserver4.message.event This class represents the BuddyStatusUpdatedEvent.
 BuddyStatusUpdatedEventCodec
com.electrotank.electroserver4.protocol.codec 
 BuddyStatusUpdatedEventTransaction
com.electrotank.electroserver4.transaction 
 ClientIdleEvent
com.electrotank.electroserver4.message.event 
 ClientIdleEventCodec
com.electrotank.electroserver4.protocol.codec 
 ClientIdleEventTransaction
com.electrotank.electroserver4.transaction 
 CompositePluginMessageEventCodec
com.electrotank.electroserver4.protocol.codec 
 CompositePluginMessageEventTransaction
com.electrotank.electroserver4.transaction 
 Connection
com.electrotank.electroserver4.connection This class is used internally to the ElectroServer class.
 ConnectionClosedEvent
com.electrotank.electroserver4.message.event If a text or binary connection to ElectroServer is closed then this event is dispatched.
 ConnectionEvent
com.electrotank.electroserver4.message.event When the client tries to establish a new text or binary socket a ConnectionEvent is eventually fired.
 ConnectionEventCodec
com.electrotank.electroserver4.protocol.codec 
 ConnectionEventTransaction
com.electrotank.electroserver4.transaction 
 CreateGameRequest
com.electrotank.electroserver4.message.request This class lets you create a new game using the Game Manager.
 CreateOrJoinGameRequestCodec
com.electrotank.electroserver4.protocol.codec 
 CreateOrJoinGameResponse
com.electrotank.electroserver4.message.response 
 CreateOrJoinGameResponseCodec
com.electrotank.electroserver4.protocol.codec 
 CreateOrJoinGameResponseTransaction
com.electrotank.electroserver4.transaction 
 CreateRoomRequest
com.electrotank.electroserver4.message.request This class represents a highly flexible server request.
 CreateRoomRequestCodec
com.electrotank.electroserver4.protocol.codec 
 CreateRoomVariableRequest
com.electrotank.electroserver4.message.request This class allows you to create a room variable.
 CreateRoomVariableRequestCodec
com.electrotank.electroserver4.protocol.codec 
 DataType
com.electrotank.electroserver4.esobject This class is used internally to map a data type to an EsObject property associated with an id.
 DeleteRoomVariableRequest
com.electrotank.electroserver4.message.request This class allows you to delete a room variable for a room that you are in.
 DeleteRoomVariableRequestCodec
com.electrotank.electroserver4.protocol.codec 
 DeleteUserVariableRequest
com.electrotank.electroserver4.message.request 
 DeleteUserVariableRequestCodec
com.electrotank.electroserver4.protocol.codec 
 Dispatcher
com.electrotank.electroserver4.utils 
 ElectroServer
com.electrotank.electroserver4 The ElectroServer class is the most-used clsas in the ElectroServer API.
 Errors
com.electrotank.electroserver4.errors This class is used to store all known error types as static variables.
 EsError
com.electrotank.electroserver4.errors This class is used to represent a type of error, like UserNamExists or RoomNotFound.
 EsObject
com.electrotank.electroserver4.esobject This class is used to represent an EsObject.
 EsObjectCodec
com.electrotank.electroserver4.protocol.codec 
 EsObjectDataHolder
com.electrotank.electroserver4.esobject This class is used internally by the EsObject class.
 EsObjectMap
com.electrotank.electroserver4.esobject This class is used internally to map a name to an EsObject value..
 EsObjectRO
com.electrotank.electroserver4.esobject This interface is used to define what is readable off of an EsObject.
 EventImpl
com.electrotank.electroserver4.message.event 
 EvictUserFromRoomRequest
com.electrotank.electroserver4.message.request This request allows a room operator to kick a user from the room.
 EvictUserFromRoomRequestCodec
com.electrotank.electroserver4.protocol.codec 
 FindGamesRequest
com.electrotank.electroserver4.message.request This request asks the Game Manager for a list of games based on a game type and search criteria.
 FindGamesRequestCodec
com.electrotank.electroserver4.protocol.codec 
 FindGamesResponse
com.electrotank.electroserver4.message.response 
 FindGamesResponseCodec
com.electrotank.electroserver4.protocol.codec 
 FindGamesResponseTransaction
com.electrotank.electroserver4.transaction 
 FindZoneAndRoomByNameRequest
com.electrotank.electroserver4.message.request Find the room id and zone id for a room and zone given the room and zone names.
 FindZoneAndRoomByNameRequestCodec
com.electrotank.electroserver4.protocol.codec 
 FindZoneAndRoomByNameResponse
com.electrotank.electroserver4.message.response 
 FindZoneAndRoomByNameResponseCodec
com.electrotank.electroserver4.protocol.codec 
 FindZoneAndRoomByNameResponseTransaction
com.electrotank.electroserver4.transaction 
 GateWayKickUserRequest
com.electrotank.electroserver4.message.request 
 GateWayKickUserRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GateWayKickUserRequestTransaction
com.electrotank.electroserver4.transaction 
 GenericErrorResponse
com.electrotank.electroserver4.message.response 
 GenericErrorResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GenericErrorResponseTransaction
com.electrotank.electroserver4.transaction 
 GetRoomsInZoneRequest
com.electrotank.electroserver4.message.request This request is used to load a list rooms given a zone name or zone id.
 GetRoomsInZoneRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GetRoomsInZoneResponse
com.electrotank.electroserver4.message.response 
 GetRoomsInZoneResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GetRoomsInZoneResponseTransaction
com.electrotank.electroserver4.transaction 
 GetUserCountRequest
com.electrotank.electroserver4.message.request This class allows you to request the number of users currently connected to ElectroServer.
 GetUserCountRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GetUserCountResponse
com.electrotank.electroserver4.message.response 
 GetUserCountResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GetUserCountResponseTransaction
com.electrotank.electroserver4.transaction 
 GetUsersInRoomRequest
com.electrotank.electroserver4.message.request Given a room id and zone id, this request loads the list of users found in a specific room.
 GetUsersInRoomRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GetUsersInRoomResponse
com.electrotank.electroserver4.message.response 
 GetUsersInRoomResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GetUsersInRoomResponseTransaction
com.electrotank.electroserver4.transaction 
 GetUserVariablesRequest
com.electrotank.electroserver4.message.request This class is used to load user variables for a user.
 GetUserVariablesRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GetUserVariablesResponse
com.electrotank.electroserver4.message.response 
 GetUserVariablesResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GetUserVariablesResponseTransaction
com.electrotank.electroserver4.transaction 
 GetZonesRequest
com.electrotank.electroserver4.message.request This request loads the list of all zones on the server.
 GetZonesRequestCodec
com.electrotank.electroserver4.protocol.codec 
 GetZonesResponse
com.electrotank.electroserver4.message.response 
 GetZonesResponseCodec
com.electrotank.electroserver4.protocol.codec 
 GetZonesResponseTransaction
com.electrotank.electroserver4.transaction 
 HttpConnection
com.electrotank.electroserver4.connection This class is used internally to the ElectroServer class.
 JoinGameRequest
com.electrotank.electroserver4.message.request This request allows you to join a specific game managed by the Game Manager by specifying a game type and game id.
 JoinRoomEvent
com.electrotank.electroserver4.message.event 
 JoinRoomEventCodec
com.electrotank.electroserver4.protocol.codec 
 JoinRoomEventTransaction
com.electrotank.electroserver4.transaction 
 JoinRoomRequest
com.electrotank.electroserver4.message.request This class is used to request joining a room.
 JoinRoomRequestCodec
com.electrotank.electroserver4.protocol.codec 
 JoinZoneEvent
com.electrotank.electroserver4.message.event 
 JoinZoneEventCodec
com.electrotank.electroserver4.protocol.codec 
 JoinZoneEventTransaction
com.electrotank.electroserver4.transaction 
 LeaveRoomEvent
com.electrotank.electroserver4.message.event 
 LeaveRoomEventCodec
com.electrotank.electroserver4.protocol.codec 
 LeaveRoomEventTransaction
com.electrotank.electroserver4.transaction 
 LeaveRoomRequest
com.electrotank.electroserver4.message.request This request allows you to leave a room.
 LeaveRoomRequestCodec
com.electrotank.electroserver4.protocol.codec 
 LeaveZoneEvent
com.electrotank.electroserver4.message.event 
 LeaveZoneEventCodec
com.electrotank.electroserver4.protocol.codec 
 LeaveZoneEventTransaction
com.electrotank.electroserver4.transaction 
 Logger
com.electrotank.electroserver4.utils 
 LoginRequest
com.electrotank.electroserver4.message.request This class is used to log into the server.
 LoginRequestCodec
com.electrotank.electroserver4.protocol.codec 
 LoginResponse
com.electrotank.electroserver4.message.response 
 LoginResponseCodec
com.electrotank.electroserver4.protocol.codec 
 LoginResponseTransaction
com.electrotank.electroserver4.transaction 
 LogoutRequest
com.electrotank.electroserver4.message.request 
 LogoutRequestCodec
com.electrotank.electroserver4.protocol.codec 
 Message
com.electrotank.electroserver4.message Interface that all requests, responses, and events must implement.
 MessageCodec
com.electrotank.electroserver4.protocol.codec 
 MessageCodecImpl
com.electrotank.electroserver4.protocol.codec 
 MessageConstants
com.electrotank.electroserver4 
 MessageImpl
com.electrotank.electroserver4.message Establishes a base set of methods that are used for all requests, responses, and events.
 MessageReader
com.electrotank.electroserver4.protocol 
 MessageType
com.electrotank.electroserver4.message This class stores static variables that act as a message definition.
 MessageWriter
com.electrotank.electroserver4.protocol 
 Observable
com.electrotank.electroserver4.utils 
 Plugin
com.electrotank.electroserver4.plugin This class is used to represent a plugin that is to be created and associated with a room.
 PluginMessageEvent
com.electrotank.electroserver4.message.event 
 PluginMessageEventCodec
com.electrotank.electroserver4.protocol.codec 
 PluginMessageEventTransaction
com.electrotank.electroserver4.transaction 
 PluginRequest
com.electrotank.electroserver4.message.request This class is used to send a message to a plugin.
 PluginRequestCodec
com.electrotank.electroserver4.protocol.codec 
 PrivateMessageEvent
com.electrotank.electroserver4.message.event 
 PrivateMessageEventCodec
com.electrotank.electroserver4.protocol.codec 
 PrivateMessageEventTransaction
com.electrotank.electroserver4.transaction 
 PrivateMessageRequest
com.electrotank.electroserver4.message.request This request is used to send private messages to one or more users at once.
 PrivateMessageRequestCodec
com.electrotank.electroserver4.protocol.codec 
 Protocol
com.electrotank.electroserver4.entities ElectroServer supports several different protocols.
 PublicMessageEvent
com.electrotank.electroserver4.message.event 
 PublicMessageEventCodec
com.electrotank.electroserver4.protocol.codec 
 PublicMessageEventTransaction
com.electrotank.electroserver4.transaction 
 PublicMessageRequest
com.electrotank.electroserver4.message.request This class is used to send a public message to a room.
 PublicMessageRequestCodec
com.electrotank.electroserver4.protocol.codec 
 QueuedMessage
com.electrotank.electroserver4.message This class is used by the ElectroServer class to store a queued message.
 QuickJoinGameRequest
com.electrotank.electroserver4.message.request This class lets you quickly create or join a game using ElectroServer's built-in Game Manager.
 RemoveBuddyRequest
com.electrotank.electroserver4.message.request This request allows you to remove a user as a buddy.
 RemoveBuddyRequestCodec
com.electrotank.electroserver4.protocol.codec 
 RemoveRoomOperatorRequest
com.electrotank.electroserver4.message.request This class allows one room operator to remove another room operator.
 RemoveRoomOperatorRequestCodec
com.electrotank.electroserver4.protocol.codec 
 ResponseImpl
com.electrotank.electroserver4.message.response 
 Room
com.electrotank.electroserver4.room This class represents a room.
 RoomVariable
com.electrotank.electroserver4.entities This class is used to represent a room variable.
 RoomVariableCodec
com.electrotank.electroserver4.protocol.codec 
 RoomVariableUpdateEvent
com.electrotank.electroserver4.message.event 
 RoomVariableUpdateEventCodec
com.electrotank.electroserver4.protocol.codec 
 RoomVariableUpdateEventTransaction
com.electrotank.electroserver4.transaction 
 RtmpConnection
com.electrotank.electroserver4.rtmpconnection 
 RtmpConnectionClosedEvent
com.electrotank.electroserver4.message.event 
 RtmpConnectionEvent
com.electrotank.electroserver4.message.event 
 RtmpOnStatusEvent
com.electrotank.electroserver4.message.event 
 SearchCriteria
com.electrotank.electroserver4.entities This class is used with the requests associated with the QuickJoinRequest and FindGamesRequest classes.
 SearchCriteriaCodec
com.electrotank.electroserver4.protocol.codec 
 SendStatus
com.electrotank.electroserver4 
 ServerGame
com.electrotank.electroserver4.entities This class is used to represent a game on the server.
 StringMessageReader
com.electrotank.electroserver4.protocol.text 
 StringMessageWriter
com.electrotank.electroserver4.protocol.text 
 Transaction
com.electrotank.electroserver4.transaction 
 TransactionHandler
com.electrotank.electroserver4.transaction 
 TransactionImpl
com.electrotank.electroserver4.transaction 
 UpdateRoomDetailsEvent
com.electrotank.electroserver4.message.event 
 UpdateRoomDetailsEventCodec
com.electrotank.electroserver4.protocol.codec 
 UpdateRoomDetailsEventTransaction
com.electrotank.electroserver4.transaction 
 UpdateRoomDetailsRequest
com.electrotank.electroserver4.message.request This request allows a user in a room to update details about that room.
 UpdateRoomDetailsRequestCodec
com.electrotank.electroserver4.protocol.codec 
 UpdateRoomVariableRequest
com.electrotank.electroserver4.message.request This class allows you to update an existing room variable.
 UpdateRoomVariableRequestCodec
com.electrotank.electroserver4.protocol.codec 
 UpdateUserVariableRequest
com.electrotank.electroserver4.message.request This request allows you to create or update a user variable on yourself.
 UpdateUserVariableRequestCodec
com.electrotank.electroserver4.protocol.codec 
 User
com.electrotank.electroserver4.user This class is used to represent a user.
 UserEvictedFromRoomEvent
com.electrotank.electroserver4.message.event 
 UserEvictedFromRoomEventCodec
com.electrotank.electroserver4.protocol.codec 
 UserEvictedFromRoomEventTransaction
com.electrotank.electroserver4.transaction 
 UserListCodec
com.electrotank.electroserver4.protocol.codec 
 UserListUpdateEvent
com.electrotank.electroserver4.message.event 
 UserListUpdateEventCodec
com.electrotank.electroserver4.protocol.codec 
 UserListUpdateEventTransaction
com.electrotank.electroserver4.transaction 
 UserManager
com.electrotank.electroserver4.user This class is used to manage all users that the client knows about.
 UserVariable
com.electrotank.electroserver4.entities This class represents a user variable for a user.
 UserVariableUpdateEvent
com.electrotank.electroserver4.message.event 
 UserVariableUpdateEventCodec
com.electrotank.electroserver4.protocol.codec 
 UserVariableUpdateEventTransaction
com.electrotank.electroserver4.transaction 
 ValidateAdditionalLoginRequestCodec
com.electrotank.electroserver4.protocol.codec 
 ValidateAdditionalLoginRequestTransaction
com.electrotank.electroserver4.transaction 
 ValidateAdditionalLoginResponse
com.electrotank.electroserver4.message.response 
 ValidateAdditionalLoginResponseCodec
com.electrotank.electroserver4.protocol.codec 
 ValidationResponse
com.electrotank.electroserver4.message This class is used to wrap a true/false validation decsion and store a list of problems if validation failed.
 Zone
com.electrotank.electroserver4.zone This class is used to represent a zone on the server.
 ZoneManager
com.electrotank.electroserver4.zone 
 ZoneUpdateEvent
com.electrotank.electroserver4.message.event 
 ZoneUpdateEventCodec
com.electrotank.electroserver4.protocol.codec 
 ZoneUpdateEventTransaction
com.electrotank.electroserver4.transaction