bwapi

Class PlayerType

java.lang.Object

bwapi.PlayerType

public class PlayerType
extends java.lang.Object

Expected type constructor. If the type is an invalid type, then it becomes Types::Unknown. A type is invalid if its value is less than 0 or greater than Types::Unknown. Parameters id The id that corresponds to this type. It is typically an integer value that corresponds to an internal Broodwar type. If the given id is invalid, then it becomes Types::Unknown.

Field Summary

Fields

Modifier and Type	Field and Description
static PlayerType	Closed
static PlayerType	Computer
static PlayerType	ComputerLeft
static PlayerType	EitherPreferComputer
static PlayerType	EitherPreferHuman
static PlayerType	Neutral
static PlayerType	None
static PlayerType	Player
static PlayerType	PlayerLeft
static PlayerType	RescuePassive
static PlayerType	Unknown

Method Summary

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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field 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

EitherPreferComputer

public static final PlayerType EitherPreferComputer

EitherPreferHuman

public static final PlayerType EitherPreferHuman

Neutral

public static final PlayerType Neutral

Closed

public static final PlayerType Closed

PlayerLeft

public static final PlayerType PlayerLeft

ComputerLeft

public static final PlayerType ComputerLeft

Unknown

public static final PlayerType Unknown

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isLobbyType

public boolean isLobbyType()

Identifies whether or not this type is used for the pre-game lobby. A type such as PlayerTypes::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 PlayerTypes::Closed would not be a valid in-game type. Returns true if the type can appear in-game, false otherwise. See also isLobbyType