PlayerType (jbwapi 2.1.0 API)

java.lang.Object
- java.lang.Enum<PlayerType>
- - bwapi.PlayerType

All Implemented Interfaces:

Serializable, Comparable<PlayerType>
```
public enum PlayerType
extends Enum<PlayerType>
```
Represents the type of controller for the player slot (i.e. human, computer).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Closed`
`Computer`
`ComputerLeft`
`EitherPreferComputer`
`EitherPreferHuman`
`Neutral`
`None`
`Observer`
`Player`
`PlayerLeft`
`RescueActive`
`RescuePassive`
`Unknown`

Field Summary

Fields
Modifier and Type Field and Description

int id

Fields
Modifier and Type	Field and Description
`int`	`id`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`isGameType()` Identifies whether or not this type is used in-game.
`boolean`	`isLobbyType()` Identifies whether or not this type is used for the pre-game lobby.
`static PlayerType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PlayerType[]`	`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
  - None
```
public static final PlayerType None
```
  - Computer
```
public static final PlayerType Computer
```
  - Player
```
public static final PlayerType Player
```
  - RescuePassive
```
public static final PlayerType RescuePassive
```
  - RescueActive
```
public static final PlayerType RescueActive
```
  - EitherPreferComputer
```
public static final PlayerType EitherPreferComputer
```
  - EitherPreferHuman
```
public static final PlayerType EitherPreferHuman
```
  - Neutral
```
public static final PlayerType Neutral
```
  - Closed
```
public static final PlayerType Closed
```
  - Observer
```
public static final PlayerType Observer
```
  - PlayerLeft
```
public static final PlayerType PlayerLeft
```
  - ComputerLeft
```
public static final PlayerType ComputerLeft
```
  - Unknown
```
public static final PlayerType Unknown
```
- Field Detail
  - id
```
public final int id
```
- Method Detail
  - values
```
public static PlayerType[] 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 (PlayerType c : PlayerType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PlayerType valueOf(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:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - isLobbyType
```
public boolean isLobbyType()
```
    Identifies whether or not this type is used for the pre-game lobby. A type such as ComputerLeft would only appear in-game when a computer player is defeated.
    
    Returns:
    
    true if this type can appear in the pre-game lobby, false otherwise.
  - isGameType
```
public boolean isGameType()
```
    Identifies whether or not this type is used in-game. A type such as Closed would not be a valid in-game type.
    
    Returns:
    
    true if the type can appear in-game, false otherwise.
    
    See Also:
    
    isLobbyType()

Enum PlayerType

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

None

Computer

Player

RescuePassive

RescueActive

EitherPreferComputer

EitherPreferHuman

Neutral

Closed

Observer

PlayerLeft

ComputerLeft

Unknown

Field Detail

id

Method Detail

values

valueOf

isLobbyType

isGameType