| Package | com.electrotank.electroserver4.errors |
| Class | public class Errors |
| Property | Defined 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
getErrorById(id:Number):EsError
[static]
Gets an error by the numeric id.
| Errors | ||
|
[static]
Registers a new error type.
| Errors | ||
| AccessDenied | property |
public static var AccessDenied:EsErrorThis 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.
| ActionCausedError | property |
public static var ActionCausedError:EsErrorThis occurs when a user does something that causes a server error. Usually related to custom plugin code.
| ActionRequiresLogin | property |
public static var ActionRequiresLogin:EsErrorThis occurs when a user tries to do something but has not yet logged into the server.
| DuplicateRoomName | property |
public static var DuplicateRoomName:EsErrorThis shouldn't ever happen but is here just in case.
| DuplicateZoneName | property |
public static var DuplicateZoneName:EsErrorThis shouldn't ever happen but is here just in case.
| EventNotFound | property |
public static var EventNotFound:EsErrorThis occurs when an event is not found.
| ExtensionForcedReload | property |
public static var ExtensionForcedReload:EsErrorThis occurs when an extension that affect this user is forced to reload.
| ExtensionNotFound | property |
public static var ExtensionNotFound:EsErrorThis occurs when a user tries to create a new plugin associated with a room and tried to use an extension that doesn't exist.
| FailedToConnect | property |
public static var FailedToConnect:EsErrorThis occurs when a user fails to connect to ElectroServer.
| FailedToJoinGameRoom | property |
public static var FailedToJoinGameRoom:EsErrorThis 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.
| FloodingFilterCheckFailed | property |
public static var FloodingFilterCheckFailed:EsErrorThis occurs when a user performs actions that are interpreted as flooding.
| GameDoesntExist | property |
public static var GameDoesntExist:EsErrorThis occurs when a user tries to join a game that doesn't exist.
| GameIsLocked | property |
public static var GameIsLocked:EsErrorThis occurs when you try to join a game that is locked.
| GatewayPaused | property |
public static var GatewayPaused:EsErrorThis occurs when a user attempts to connect to a gateway that is paused. A gateway can be paused or resumed via the web admin.
| GenericError | property |
public static var GenericError:EsErrorThis occurs when a generic server error is enountered with no specific meaning.
| IdleTimeReached | property |
public static var IdleTimeReached:EsErrorThis 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.
| InboundMessageFailedValidation | property |
public static var InboundMessageFailedValidation:EsErrorThis occurs when a message sent from the client to the server failed validation.
| InvalidFloodingFilterSettings | property |
public static var InvalidFloodingFilterSettings:EsErrorThis occurs during the creation of a room if the flooding filter settings are invalid.
| InvalidLanguageFilterSettings | property |
public static var InvalidLanguageFilterSettings:EsErrorThis occurs during the creation of a room if the language filter settings are invalid.
| InvalidMessageNumber | property |
public static var InvalidMessageNumber:EsErrorThis occurs if for some reason the API sends the wrong message number tagged on the message.
| InvalidParameters | property |
public static var InvalidParameters:EsErrorInvalid parameters.
| InvalidUserName | property |
public static var InvalidUserName:EsErrorThis occurs when a user name used during login is invalid.
| LoginEventHandlerFailure | property |
public static var LoginEventHandlerFailure:EsErrorThis occurs when a user tries to login and there is a custom Login Event Handler established on the server, and it errors.
| ManagedObjectNotFound | property |
public static var ManagedObjectNotFound:EsErrorThis occurs when a managed object (part of the extension model) is not found.
| MaximumClientConnectionsReached | property |
public static var MaximumClientConnectionsReached:EsErrorThis 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.
| OnlyRtmpConnectionRemains | property |
public static var OnlyRtmpConnectionRemains:EsErrorThis occurs when a all connections except the optional RTMP connection remains.
| OperationNotSupported | property |
public static var OperationNotSupported:EsErrorThis occurs when a user tries to do something that is not supported under the license conditions of the server.
| PluginInitializationFailed | property |
public static var PluginInitializationFailed:EsErrorThis occurs when a associated with a room that the user has created fails to initialize.
| PluginNotFound | property |
public static var PluginNotFound:EsErrorThis occurs when a user tries to interact with a plugin that doesn't exist.
| PublicMessageRejected | property |
public static var PublicMessageRejected:EsErrorThis occurs when a public message is rejected by a server event handler.
| RoomAllocationFailure | property |
public static var RoomAllocationFailure:EsErrorThis shouldn't ever happen but is here just in case.
| RoomAtCapacity | property |
public static var RoomAtCapacity:EsErrorThis occurs when a room is at capacity and another user tries to join.
| RoomNotFound | property |
public static var RoomNotFound:EsErrorThis occurs when the client is trying to access a room in some way (such as JoinRoomRequest) and that room doesn't exist.
| RoomPasswordMismatch | property |
public static var RoomPasswordMismatch:EsErrorThis occurs when a user tries to join the room with the wrong password.
| RoomVariableAlreadyExists | property |
public static var RoomVariableAlreadyExists:EsErrorThis occurs when a user tries to create a room variable that already exists.
| RoomVariableLocked | property |
public static var RoomVariableLocked:EsErrorThis occurs when a user tries to update the value of a locked room variable.
| ServerError | property |
public static var ServerError:EsErrorThis occurs when a non-specific server error happens.
| UserAlreadyInRoom | property |
public static var UserAlreadyInRoom:EsErrorThis occurs when a user tries to join a room that they are already in.
| UserAlreadyLoggedIn | property |
public static var UserAlreadyLoggedIn:EsErrorThis occurs when you try to log in and you are already logged in.
| UserBanned | property |
public static var UserBanned:EsErrorThis occurs when a user is banned from the server.
| UserLogOutRequested | property |
public static var UserLogOutRequested:EsErrorThis occurs when the server requests that the client log out.
| UserNameExists | property |
public static var UserNameExists:EsErrorThis occurs when you try to login with a name that is taken.
| UserNotJoinedToRoom | property |
public static var UserNotJoinedToRoom:EsErrorThis occurs when a user tries to do something (such as send messages) in a room that they are not in.
| UserVariableAlreadyExists | property |
public static var UserVariableAlreadyExists:EsErrorThis occurs when a user tries to create a user variable that already exists.
| UserVariableDoesNotExist | property |
public static var UserVariableDoesNotExist:EsErrorThis occurs when a user tries to update a user variable that does not exist.
| VulgarityCheckFailed | property |
public static var VulgarityCheckFailed:EsErrorThis occurs when something fails a language filter check.
| ZoneAllocationFailure | property |
public static var ZoneAllocationFailure:EsErrorThis shouldn't ever happen but is here just in case.
| ZoneNotFound | property |
public static var ZoneNotFound:EsErrorThis occurs if the client is trying to access a zone in some way (such as GetRoomsInZoneRequest) and that zone doesn't exist.
| getErrorById | () | method |
public static function getErrorById(id:Number):EsErrorGets an error by the numeric id.
Parametersid:Number — The error id.
|
EsError —
The error found with the id.
|
| register | () | method |
public static function register(err:EsError):EsErrorRegisters a new error type.
Parameterserr:EsError — The error.
|
EsError —
The error.
|