ClientError (com.github.ocraft:ocraft-s2client 0.2.6-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<ClientError>
- - com.github.ocraft.s2client.bot.ClientError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ClientError>
```
public enum ClientError
extends java.lang.Enum<ClientError>
```

Enum Constant Summary

Enum Constants
Enum Constant	Description
`CONNECTION_CLOSED`	The websocket connection has prematurely closed, this could mean starcraft crashed or a websocket timeout has occurred.
`ERROR_SC2`
`INVALID_ABILITY_REMAP`	An ability was improperly mapped to an ability id that doesn't exist.
`INVALID_RESPONSE`	The response does not contain a field that was expected.
`NO_ABILITIES_FOR_TAG`	The unit does not have any abilities.
`RESPONSE_MISMATCH`	The response received from SC2 does not match the request.
`RESPONSE_NOT_CONSUMED`	A request was made without consuming the response from the previous request of given type.
`SC2_APP_FAILURE`	SC2 has either crashed or been forcibly terminated by this library because it was not responding to requests.
`SC2_PROTOCOL_ERROR`	The response from SC2 contains errors, most likely meaning the API was not used in a correct way.
`SC2_PROTOCOL_TIMEOUT`	A request was made and a response was not received in the amount of time given by the timeout.
`SC2_UNKNOWN_STATUS`
`WRONG_GAME_VERSION`	A replay was attempted to be loaded in the wrong game version.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static ClientError`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static ClientError[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ERROR_SC2
```
public static final ClientError ERROR_SC2
```
  - INVALID_ABILITY_REMAP
```
public static final ClientError INVALID_ABILITY_REMAP
```
    An ability was improperly mapped to an ability id that doesn't exist.
  - INVALID_RESPONSE
```
public static final ClientError INVALID_RESPONSE
```
    The response does not contain a field that was expected.
  - NO_ABILITIES_FOR_TAG
```
public static final ClientError NO_ABILITIES_FOR_TAG
```
    The unit does not have any abilities.
  - RESPONSE_NOT_CONSUMED
```
public static final ClientError RESPONSE_NOT_CONSUMED
```
    A request was made without consuming the response from the previous request of given type.
  - RESPONSE_MISMATCH
```
public static final ClientError RESPONSE_MISMATCH
```
    The response received from SC2 does not match the request.
  - CONNECTION_CLOSED
```
public static final ClientError CONNECTION_CLOSED
```
    The websocket connection has prematurely closed, this could mean starcraft crashed or a websocket timeout has occurred.
  - SC2_UNKNOWN_STATUS
```
public static final ClientError SC2_UNKNOWN_STATUS
```
  - SC2_APP_FAILURE
```
public static final ClientError SC2_APP_FAILURE
```
    SC2 has either crashed or been forcibly terminated by this library because it was not responding to requests.
  - SC2_PROTOCOL_ERROR
```
public static final ClientError SC2_PROTOCOL_ERROR
```
    The response from SC2 contains errors, most likely meaning the API was not used in a correct way.
  - SC2_PROTOCOL_TIMEOUT
```
public static final ClientError SC2_PROTOCOL_TIMEOUT
```
    A request was made and a response was not received in the amount of time given by the timeout.
  - WRONG_GAME_VERSION
```
public static final ClientError WRONG_GAME_VERSION
```
    A replay was attempted to be loaded in the wrong game version.
- Method Detail
  - values
```
public static ClientError[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ClientError c : ClientError.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ClientError valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum ClientError

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ERROR_SC2

INVALID_ABILITY_REMAP

INVALID_RESPONSE

NO_ABILITIES_FOR_TAG

RESPONSE_NOT_CONSUMED

RESPONSE_MISMATCH

CONNECTION_CLOSED

SC2_UNKNOWN_STATUS

SC2_APP_FAILURE

SC2_PROTOCOL_ERROR

SC2_PROTOCOL_TIMEOUT

WRONG_GAME_VERSION

Method Detail

values

valueOf