Player

java.lang.Object
- bwapi.Player

```
public class Player
extends java.lang.Object
```
Each player in a match will have his or her own player instance. There is also a neutral player which owns all the neutral units.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`airWeaponMaxRange(UnitType unit)` Returns the max air weapon range of the given unit type, includes upgrades
`int`	`allUnitCount(UnitType unit)` Returns the number of all accessible units of the given type.
`int`	`armor(UnitType unit)` Returns the armor of the given unit type, includes upgrades
`int`	`completedUnitCount(UnitType unit)` Returns the number of completed units of the given type.
`int`	`deadUnitCount(UnitType unit)` Returns the number of dead units of the given type.
`int`	`gas()` Returns the amount of vespene gas the player has.
`int`	`gatheredGas()` Returns the cumulative amount of gas the player has harvested up to this point.
`int`	`gatheredMinerals()` Returns the cumulative amount of minerals the player has mined up to this point (including the 50 minerals at the start of the game).
`int`	`getBuildingScore()` Returns the Player's Total Buildings Score
`Color`	`getColor()` Returns the color of the player for drawing
`int`	`getCustomScore()` Returns the Player's Custom Score
`Force`	`getForce()` Returns the force the player is on.
`int`	`getID()` Returns a unique ID for the player.
`int`	`getKillScore()` Returns the Player's Total Kill Score
`java.lang.String`	`getName()` Returns the name of the player.
`Race`	`getRace()` Returns the race of the player.
`int`	`getRazingScore()` Returns the Player's Total Razings Score
`TilePosition`	`getStartLocation()` Returns the starting location of the player.
`int`	`getTextColor()` Returns the color of the player for text messages
`PlayerType`	`getType()` Returns the type of the player.
`java.util.List<Unit>`	`getUnits()` Returns the set of units the player own.
`int`	`getUnitScore()` Returns the Player's Total Unit Score
`int`	`groundWeaponDamageCooldown(UnitType unit)` Returns the ground weapon cooldown of the given unit type, includes upgrades
`int`	`groundWeaponMaxRange(UnitType unit)` Returns the max ground weapon range of the given unit type, includes upgrades
`boolean`	`hasResearched(TechType tech)` Returns the player's current upgrade level of the given upgrade.
`int`	`incompleteUnitCount(UnitType unit)` Returns the number of incomplete units of the given type.
`boolean`	`isAlly(Player player)` Returns true if other player is an ally of this player.
`boolean`	`isDefeated()` Returns true if the player has been defeated.
`boolean`	`isEnemy(Player player)` Returns true if other player is an enemy of this player.
`boolean`	`isNeutral()` Returns true if the player is the neutral player.
`boolean`	`isObserver()` Returns true if the Player is only observing the game, and not participating
`boolean`	`isResearchAvailable(TechType tech)` Returns the maximum upgrades available specific to the player (Use Map Settings).
`boolean`	`isResearching(TechType tech)` Returns true if the player is researching the given tech.
`boolean`	`isUnitAvailable(UnitType unit)` Returns true if the unit is available for the player to build (Use Map Settings).
`boolean`	`isUpgrading(UpgradeType upgrade)` Returns true if the player is upgrading the given upgrade.
`boolean`	`isVictorious()` Returns true if the player has achieved victory.
`int`	`killedUnitCount(UnitType unit)` Returns the number of killed units of the given type.
`boolean`	`leftGame()` Returns true if the player left the game.
`int`	`maxEnergy(UnitType unit)` Returns the max energy of the given unit type, taking into account upgrades
`int`	`minerals()` Returns the amount of minerals the player has.
`int`	`refundedGas()` Returns the cumulative amount of gas the player has gained from refunded units up to this point.
`int`	`refundedMinerals()` Returns the cumulative amount of minerals the player has gained from refunded units up to this point.
`int`	`repairedGas()` Returns the cumulative amount of gas the player has spent on repairs up to this point.
`int`	`repairedMinerals()` Returns the cumulative amount of minerals the player has spent on repairs up to this point.
`int`	`sightRange(UnitType unit)` Returns the sight range of the given unit type, includes upgrades
`int`	`spentGas()` Returns the cumulative amount of gas the player has spent up to this point (not including repairs).
`int`	`spentMinerals()` Returns the cumulative amount of minerals the player has spent up to this point (not including repairs).
`int`	`supplyTotal()` Returns the total amount of supply the player has.
`int`	`supplyTotal(Race race)`
`int`	`supplyUsed()` Returns how much of the supply is actually being used by units.
`int`	`supplyUsed(Race race)`
`double`	`topSpeed(UnitType unit)` Returns the top speed of the given unit type, includes upgrades
`int`	`visibleUnitCount(UnitType unit)` Returns the number of visible units of the given type.
`int`	`weaponMaxRange(WeaponType weapon)` Returns the max range of the given weapon with upgrades

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

- Method Detail
  - getID
```
public int getID()
```
    Returns a unique ID for the player.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the player.
  - getUnits
```
public java.util.List<Unit> getUnits()
```
    Returns the set of units the player own. Note that units loaded into Terran dropships, Terran bunkers, Terran refineries, Protoss assimilators, and Zerg extractors are not yet included in the set.
  - getRace
```
public Race getRace()
```
    Returns the race of the player.
  - getType
```
public PlayerType getType()
```
    Returns the type of the player.
  - getForce
```
public Force getForce()
```
    Returns the force the player is on.
  - isAlly
```
public boolean isAlly(Player player)
```
    Returns true if other player is an ally of this player.
  - isEnemy
```
public boolean isEnemy(Player player)
```
    Returns true if other player is an enemy of this player.
  - isNeutral
```
public boolean isNeutral()
```
    Returns true if the player is the neutral player.
  - getStartLocation
```
public TilePosition getStartLocation()
```
    Returns the starting location of the player. If complete map information is disabled, this function will return TilePositions::Unknown for enemy players. For the complete set of starting locations for the current map, see Game::getStartLocations.
  - isVictorious
```
public boolean isVictorious()
```
    Returns true if the player has achieved victory.
  - isDefeated
```
public boolean isDefeated()
```
    Returns true if the player has been defeated.
  - leftGame
```
public boolean leftGame()
```
    Returns true if the player left the game.
  - minerals
```
public int minerals()
```
    Returns the amount of minerals the player has.
  - gas
```
public int gas()
```
    Returns the amount of vespene gas the player has.
  - gatheredMinerals
```
public int gatheredMinerals()
```
    Returns the cumulative amount of minerals the player has mined up to this point (including the 50 minerals at the start of the game).
  - gatheredGas
```
public int gatheredGas()
```
    Returns the cumulative amount of gas the player has harvested up to this point.
  - repairedMinerals
```
public int repairedMinerals()
```
    Returns the cumulative amount of minerals the player has spent on repairs up to this point.
  - repairedGas
```
public int repairedGas()
```
    Returns the cumulative amount of gas the player has spent on repairs up to this point.
  - refundedMinerals
```
public int refundedMinerals()
```
    Returns the cumulative amount of minerals the player has gained from refunded units up to this point.
  - refundedGas
```
public int refundedGas()
```
    Returns the cumulative amount of gas the player has gained from refunded units up to this point.
  - spentMinerals
```
public int spentMinerals()
```
    Returns the cumulative amount of minerals the player has spent up to this point (not including repairs).
  - spentGas
```
public int spentGas()
```
    Returns the cumulative amount of gas the player has spent up to this point (not including repairs).
  - supplyTotal
```
public int supplyTotal()
```
    Returns the total amount of supply the player has. If a race is provided, the total supply for the given race will be returned, otherwise the player's initial race will be used. Supply counts returned by BWAPI are double what you would expect to see from playing the game. This is because zerglings take up 0.5 in-game supply.
  - supplyTotal
```
public int supplyTotal(Race race)
```
  - supplyUsed
```
public int supplyUsed()
```
    Returns how much of the supply is actually being used by units. If a race is provided, the used supply for the given race will be returned, otherwise the player's initial race will be used. Supply counts returned by BWAPI are double what you would expect to see from playing the game. This is because zerglings take up 0.5 in-game supply.
  - supplyUsed
```
public int supplyUsed(Race race)
```
  - allUnitCount
```
public int allUnitCount(UnitType unit)
```
    Returns the number of all accessible units of the given type.
  - visibleUnitCount
```
public int visibleUnitCount(UnitType unit)
```
    Returns the number of visible units of the given type.
  - completedUnitCount
```
public int completedUnitCount(UnitType unit)
```
    Returns the number of completed units of the given type.
  - incompleteUnitCount
```
public int incompleteUnitCount(UnitType unit)
```
    Returns the number of incomplete units of the given type.
  - deadUnitCount
```
public int deadUnitCount(UnitType unit)
```
    Returns the number of dead units of the given type.
  - killedUnitCount
```
public int killedUnitCount(UnitType unit)
```
    Returns the number of killed units of the given type.
  - hasResearched
```
public boolean hasResearched(TechType tech)
```
    Returns the player's current upgrade level of the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.
  - isResearching
```
public boolean isResearching(TechType tech)
```
    Returns true if the player is researching the given tech. To order a unit to research a given tech type, see Unit::reseach.
  - isUpgrading
```
public boolean isUpgrading(UpgradeType upgrade)
```
    Returns true if the player is upgrading the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.
  - getColor
```
public Color getColor()
```
    Returns the color of the player for drawing
  - getTextColor
```
public int getTextColor()
```
    Returns the color of the player for text messages
  - maxEnergy
```
public int maxEnergy(UnitType unit)
```
    Returns the max energy of the given unit type, taking into account upgrades
  - topSpeed
```
public double topSpeed(UnitType unit)
```
    Returns the top speed of the given unit type, includes upgrades
  - groundWeaponMaxRange
```
public int groundWeaponMaxRange(UnitType unit)
```
    Returns the max ground weapon range of the given unit type, includes upgrades
  - airWeaponMaxRange
```
public int airWeaponMaxRange(UnitType unit)
```
    Returns the max air weapon range of the given unit type, includes upgrades
  - weaponMaxRange
```
public int weaponMaxRange(WeaponType weapon)
```
    Returns the max range of the given weapon with upgrades
  - sightRange
```
public int sightRange(UnitType unit)
```
    Returns the sight range of the given unit type, includes upgrades
  - groundWeaponDamageCooldown
```
public int groundWeaponDamageCooldown(UnitType unit)
```
    Returns the ground weapon cooldown of the given unit type, includes upgrades
  - armor
```
public int armor(UnitType unit)
```
    Returns the armor of the given unit type, includes upgrades
  - getUnitScore
```
public int getUnitScore()
```
    Returns the Player's Total Unit Score
  - getKillScore
```
public int getKillScore()
```
    Returns the Player's Total Kill Score
  - getBuildingScore
```
public int getBuildingScore()
```
    Returns the Player's Total Buildings Score
  - getRazingScore
```
public int getRazingScore()
```
    Returns the Player's Total Razings Score
  - getCustomScore
```
public int getCustomScore()
```
    Returns the Player's Custom Score
  - isObserver
```
public boolean isObserver()
```
    Returns true if the Player is only observing the game, and not participating
  - isResearchAvailable
```
public boolean isResearchAvailable(TechType tech)
```
    Returns the maximum upgrades available specific to the player (Use Map Settings).
  - isUnitAvailable
```
public boolean isUnitAvailable(UnitType unit)
```
    Returns true if the unit is available for the player to build (Use Map Settings).

Class Player

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getID

getName

getUnits

getRace

getType

getForce

isAlly

isEnemy

isNeutral

getStartLocation

isVictorious

isDefeated

leftGame

minerals

gas

gatheredMinerals

gatheredGas

repairedMinerals

repairedGas

refundedMinerals

refundedGas

spentMinerals

spentGas

supplyTotal

supplyTotal

supplyUsed

supplyUsed

allUnitCount

visibleUnitCount

completedUnitCount

incompleteUnitCount

deadUnitCount

killedUnitCount

hasResearched

isResearching

isUpgrading

getColor

getTextColor

maxEnergy

topSpeed

groundWeaponMaxRange

airWeaponMaxRange

weaponMaxRange

sightRange

groundWeaponDamageCooldown

armor

getUnitScore

getKillScore

getBuildingScore

getRazingScore

getCustomScore

isObserver

isResearchAvailable

isUnitAvailable