Packagecom.electrotank.electroserver4.errors
Classpublic class Errors

This class is used to store all known error types as static variables.



Public Properties
 PropertyDefined by
  AccessDenied : EsError
[static] This occurs when a user tries to do something they don't have permission to do.
Errors
  ActionCausedError : EsError
[static] This occurs when a user does something that causes a server error.
Errors
  ActionRequiresLogin : EsError
[static] This occurs when a user tries to do something but has not yet logged into the server.
Errors
  DuplicateRoomName : EsError
[static] This shouldn't ever happen but is here just in case.
Errors
  DuplicateZoneName : EsError
[static] This shouldn't ever happen but is here just in case.
Errors
  EventNotFound : EsError
[static] This occurs when an event is not found.
Errors
  ExtensionForcedReload : EsError
[static] This occurs when an extension that affect this user is forced to reload.
Errors
  ExtensionNotFound : EsError
[static] This occurs when a user tries to create a new plugin associated with a room and tried to use an extension that doesn't exist.
Errors
  FailedToConnect : EsError
[static] This occurs when a user fails to connect to ElectroServer.
Errors
  FailedToJoinGameRoom : EsError
[static] This occurs when a user tries to join a game room and fails.
Errors
  FloodingFilterCheckFailed : EsError
[static] This occurs when a user performs actions that are interpreted as flooding.
Errors
  GameDoesntExist : EsError
[static] This occurs when a user tries to join a game that doesn't exist.
Errors
  GameIsLocked : EsError
[static] This occurs when you try to join a game that is locked.
Errors
  GatewayPaused : EsError
[static] This occurs when a user attempts to connect to a gateway that is paused.
Errors
  GenericError : EsError
[static] This occurs when a generic server error is enountered with no specific meaning.
Errors
  IdleTimeReached : EsError
[static] This occurs when a connected user has been inactive for a time longer that the idle disconnect time defined in the web admin.
Errors
  InboundMessageFailedValidation : EsError
[static] This occurs when a message sent from the client to the server failed validation.
Errors
  InvalidFloodingFilterSettings : EsError
[static] This occurs during the creation of a room if the flooding filter settings are invalid.
Errors
  InvalidLanguageFilterSettings : EsError
[static] This occurs during the creation of a room if the language filter settings are invalid.
Errors
  InvalidMessageNumber : EsError
[static] This occurs if for some reason the API sends the wrong message number tagged on the message.
Errors
  InvalidParameters : EsError
[static] Invalid parameters.
Errors
  InvalidUserName : EsError
[static] This occurs when a user name used during login is invalid.
Errors
  LoginEventHandlerFailure : EsError
[static] This occurs when a user tries to login and there is a custom Login Event Handler established on the server, and it errors.
Errors
  ManagedObjectNotFound : EsError
[static] This occurs when a managed object (part of the extension model) is not found.
Errors
  MaximumClientConnectionsReached : EsError
[static] This occurs when the number of clients connected to ElectroServer has reached what is defined in the license file or in the web-based admin.
Errors
  OnlyRtmpConnectionRemains : EsError
[static] This occurs when a all connections except the optional RTMP connection remains.
Errors
  OperationNotSupported : EsError
[static] This occurs when a user tries to do something that is not supported under the license conditions of the server.
Errors
  PluginInitializationFailed : EsError
[static] This occurs when a associated with a room that the user has created fails to initialize.
Errors
  PluginNotFound : EsError
[static] This occurs when a user tries to interact with a plugin that doesn't exist.
Errors
  PublicMessageRejected : EsError
[static] This occurs when a public message is rejected by a server event handler.
Errors
  RoomAllocationFailure : EsError
[static] This shouldn't ever happen but is here just in case.
Errors
  RoomAtCapacity : EsError
[static] This occurs when a room is at capacity and another user tries to join.
Errors
  RoomNotFound : EsError
[static] This occurs when the client is trying to access a room in some way (such as JoinRoomRequest) and that room doesn't exist.
Errors
  RoomPasswordMismatch : EsError
[static] This occurs when a user tries to join the room with the wrong password.
Errors
  RoomVariableAlreadyExists : EsError
[static] This occurs when a user tries to create a room variable that already exists.
Errors
  RoomVariableLocked : EsError
[static] This occurs when a user tries to update the value of a locked room variable.
Errors
  ServerError : EsError
[static] This occurs when a non-specific server error happens.
Errors
  UserAlreadyInRoom : EsError
[static] This occurs when a user tries to join a room that they are already in.
Errors
  UserAlreadyLoggedIn : EsError
[static] This occurs when you try to log in and you are already logged in.
Errors
  UserBanned : EsError
[static] This occurs when a user is banned from the server.
Errors
  UserLogOutRequested : EsError
[static] This occurs when the server requests that the client log out.
Errors
  UserNameExists : EsError
[static] This occurs when you try to login with a name that is taken.
Errors
  UserNotJoinedToRoom : EsError
[static] This occurs when a user tries to do something (such as send messages) in a room that they are not in.
Errors
  UserVariableAlreadyExists : EsError
[static] This occurs when a user tries to create a user variable that already exists.
Errors
  UserVariableDoesNotExist : EsError
[static] This occurs when a user tries to update a user variable that does not exist.
Errors
  VulgarityCheckFailed : EsError
[static] This occurs when something fails a language filter check.
Errors
  ZoneAllocationFailure : EsError
[static] This shouldn't ever happen but is here just in case.
Errors
  ZoneNotFound : EsError
[static] This occurs if the client is trying to access a zone in some way (such as GetRoomsInZoneRequest) and that zone doesn't exist.
Errors
Public Methods
 MethodDefined by
  
getErrorById(id:Number):EsError
[static] Gets an error by the numeric id.
Errors
  
[static] Registers a new error type.
Errors
Property detail
AccessDeniedproperty
public static var AccessDenied:EsError

This occurs when a user tries to do something they don't have permission to do. Permission sets can be established via the web admin, and assigned to users as they login.

ActionCausedErrorproperty 
public static var ActionCausedError:EsError

This occurs when a user does something that causes a server error. Usually related to custom plugin code.

ActionRequiresLoginproperty 
public static var ActionRequiresLogin:EsError

This occurs when a user tries to do something but has not yet logged into the server.

DuplicateRoomNameproperty 
public static var DuplicateRoomName:EsError

This shouldn't ever happen but is here just in case.

DuplicateZoneNameproperty 
public static var DuplicateZoneName:EsError

This shouldn't ever happen but is here just in case.

EventNotFoundproperty 
public static var EventNotFound:EsError

This occurs when an event is not found.

ExtensionForcedReloadproperty 
public static var ExtensionForcedReload:EsError

This occurs when an extension that affect this user is forced to reload.

ExtensionNotFoundproperty 
public static var ExtensionNotFound:EsError

This occurs when a user tries to create a new plugin associated with a room and tried to use an extension that doesn't exist.

FailedToConnectproperty 
public static var FailedToConnect:EsError

This occurs when a user fails to connect to ElectroServer.

FailedToJoinGameRoomproperty 
public static var FailedToJoinGameRoom:EsError

This occurs when a user tries to join a game room and fails. This could be due to the wrong password, the game being full, or the game plugin just rejecting the user for any reason it wants.

FloodingFilterCheckFailedproperty 
public static var FloodingFilterCheckFailed:EsError

This occurs when a user performs actions that are interpreted as flooding.

GameDoesntExistproperty 
public static var GameDoesntExist:EsError

This occurs when a user tries to join a game that doesn't exist.

GameIsLockedproperty 
public static var GameIsLocked:EsError

This occurs when you try to join a game that is locked.

GatewayPausedproperty 
public static var GatewayPaused:EsError

This occurs when a user attempts to connect to a gateway that is paused. A gateway can be paused or resumed via the web admin.

GenericErrorproperty 
public static var GenericError:EsError

This occurs when a generic server error is enountered with no specific meaning.

IdleTimeReachedproperty 
public static var IdleTimeReached:EsError

This occurs when a connected user has been inactive for a time longer that the idle disconnect time defined in the web admin. The user is then disconnected.

InboundMessageFailedValidationproperty 
public static var InboundMessageFailedValidation:EsError

This occurs when a message sent from the client to the server failed validation.

InvalidFloodingFilterSettingsproperty 
public static var InvalidFloodingFilterSettings:EsError

This occurs during the creation of a room if the flooding filter settings are invalid.

InvalidLanguageFilterSettingsproperty 
public static var InvalidLanguageFilterSettings:EsError

This occurs during the creation of a room if the language filter settings are invalid.

InvalidMessageNumberproperty 
public static var InvalidMessageNumber:EsError

This occurs if for some reason the API sends the wrong message number tagged on the message.

InvalidParametersproperty 
public static var InvalidParameters:EsError

Invalid parameters.

InvalidUserNameproperty 
public static var InvalidUserName:EsError

This occurs when a user name used during login is invalid.

LoginEventHandlerFailureproperty 
public static var LoginEventHandlerFailure:EsError

This occurs when a user tries to login and there is a custom Login Event Handler established on the server, and it errors.

ManagedObjectNotFoundproperty 
public static var ManagedObjectNotFound:EsError

This occurs when a managed object (part of the extension model) is not found.

MaximumClientConnectionsReachedproperty 
public static var MaximumClientConnectionsReached:EsError

This occurs when the number of clients connected to ElectroServer has reached what is defined in the license file or in the web-based admin. This error occurs for the next person trying to connect and login.

OnlyRtmpConnectionRemainsproperty 
public static var OnlyRtmpConnectionRemains:EsError

This occurs when a all connections except the optional RTMP connection remains.

OperationNotSupportedproperty 
public static var OperationNotSupported:EsError

This occurs when a user tries to do something that is not supported under the license conditions of the server.

PluginInitializationFailedproperty 
public static var PluginInitializationFailed:EsError

This occurs when a associated with a room that the user has created fails to initialize.

PluginNotFoundproperty 
public static var PluginNotFound:EsError

This occurs when a user tries to interact with a plugin that doesn't exist.

PublicMessageRejectedproperty 
public static var PublicMessageRejected:EsError

This occurs when a public message is rejected by a server event handler.

RoomAllocationFailureproperty 
public static var RoomAllocationFailure:EsError

This shouldn't ever happen but is here just in case.

RoomAtCapacityproperty 
public static var RoomAtCapacity:EsError

This occurs when a room is at capacity and another user tries to join.

RoomNotFoundproperty 
public static var RoomNotFound:EsError

This occurs when the client is trying to access a room in some way (such as JoinRoomRequest) and that room doesn't exist.

RoomPasswordMismatchproperty 
public static var RoomPasswordMismatch:EsError

This occurs when a user tries to join the room with the wrong password.

RoomVariableAlreadyExistsproperty 
public static var RoomVariableAlreadyExists:EsError

This occurs when a user tries to create a room variable that already exists.

RoomVariableLockedproperty 
public static var RoomVariableLocked:EsError

This occurs when a user tries to update the value of a locked room variable.

ServerErrorproperty 
public static var ServerError:EsError

This occurs when a non-specific server error happens.

UserAlreadyInRoomproperty 
public static var UserAlreadyInRoom:EsError

This occurs when a user tries to join a room that they are already in.

UserAlreadyLoggedInproperty 
public static var UserAlreadyLoggedIn:EsError

This occurs when you try to log in and you are already logged in.

UserBannedproperty 
public static var UserBanned:EsError

This occurs when a user is banned from the server.

UserLogOutRequestedproperty 
public static var UserLogOutRequested:EsError

This occurs when the server requests that the client log out.

UserNameExistsproperty 
public static var UserNameExists:EsError

This occurs when you try to login with a name that is taken.

UserNotJoinedToRoomproperty 
public static var UserNotJoinedToRoom:EsError

This occurs when a user tries to do something (such as send messages) in a room that they are not in.

UserVariableAlreadyExistsproperty 
public static var UserVariableAlreadyExists:EsError

This occurs when a user tries to create a user variable that already exists.

UserVariableDoesNotExistproperty 
public static var UserVariableDoesNotExist:EsError

This occurs when a user tries to update a user variable that does not exist.

VulgarityCheckFailedproperty 
public static var VulgarityCheckFailed:EsError

This occurs when something fails a language filter check.

ZoneAllocationFailureproperty 
public static var ZoneAllocationFailure:EsError

This shouldn't ever happen but is here just in case.

ZoneNotFoundproperty 
public static var ZoneNotFound:EsError

This occurs if the client is trying to access a zone in some way (such as GetRoomsInZoneRequest) and that zone doesn't exist.

Method detail
getErrorById()method
public static function getErrorById(id:Number):EsError

Gets an error by the numeric id.

Parameters
id:Number — The error id.

Returns
EsError — The error found with the id.
register()method 
public static function register(err:EsError):EsError

Registers a new error type.

Parameters
err:EsError — The error.

Returns
EsError — The error.