Player (jbwapi 2.1.0 API)

java.lang.Object
- bwapi.Player

All Implemented Interfaces:

Comparable<Player>
```
public class Player
extends Object
implements Comparable<Player>
```
The Player represents a unique controller in the game. 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 (such as mineral patches and vespene geysers).

See Also:

PlayerType, Race

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`allUnitCount()`
`int`	`allUnitCount(UnitType unit)` Retrieves the total number of units that the player has.
`int`	`armor(UnitType unit)` Calculates the armor that a given unit type will have, including upgrades.
`int`	`compareTo(Player other)`
`int`	`completedUnitCount()`
`int`	`completedUnitCount(UnitType unit)` Retrieves the number of completed units that the player has.
`int`	`damage(WeaponType wpn)` Calculates the damage that a given weapon type can deal, including upgrades.
`int`	`deadUnitCount()`
`int`	`deadUnitCount(UnitType unit)` Retrieves the number units that have died for this player.
`boolean`	`equals(Object o)`
`int`	`gas()` Retrieves the current amount of vespene gas that this player has.
`int`	`gatheredGas()` Retrieves the cumulative amount of vespene gas that this player has gathered since the beginning of the game, including the amount that the player starts the game with (if any).
`int`	`gatheredMinerals()` Retrieves the cumulative amount of minerals/ore that this player has gathered since the beginning of the game, including the amount that the player starts the game with (if any).
`int`	`getBuildingScore()` Retrieves the total building score, as seen in the end-game score screen.
`Color`	`getColor()` Retrieves the color value of the current player.
`int`	`getCustomScore()` Retrieves the player's custom score.
`Force`	`getForce()` Retrieves the player's force.
`int`	`getID()` Retrieves a unique ID that represents the player.
`int`	`getKillScore()` Retrieves the total kill score, as seen in the end-game score screen.
`int`	`getMaxUpgradeLevel(UpgradeType upgrade)` Retrieves the maximum upgrades available specific to the player.
`String`	`getName()` Retrieves the name of the player.
`Race`	`getRace()` Retrieves the race of the player.
`int`	`getRazingScore()` Retrieves the total razing score, as seen in the end-game score screen.
`TilePosition`	`getStartLocation()` Retrieve's the player's starting location.
`Text`	`getTextColor()` Retrieves the control code character that changes the color of text messages to represent this player.
`PlayerType`	`getType()` Retrieves the player's controller type.
`List<Unit>`	`getUnits()` Retrieves the set of all units that the player owns.
`int`	`getUnitScore()` Retrieves the total unit score, as seen in the end-game score screen.
`int`	`getUpgradeLevel(UpgradeType upgrade)` Retrieves the current upgrade level that the player has attained for a given upgrade type.
`int`	`hashCode()`
`boolean`	`hasResearched(TechType tech)` Checks if the player has already researched a given technology.
`boolean`	`hasUnitTypeRequirement(UnitType unit)`
`boolean`	`hasUnitTypeRequirement(UnitType unit, int amount)` Verifies that this player satisfies a unit type requirement.
`int`	`incompleteUnitCount()`
`int`	`incompleteUnitCount(UnitType unit)` Retrieves the number of incomplete units that the player has.
`boolean`	`isAlly(Player player)` Checks if this player is allied to the specified player.
`boolean`	`isDefeated()` Checks if the player has been defeated.
`boolean`	`isEnemy(Player player)` Checks if this player is unallied to the specified player.
`boolean`	`isNeutral()` Checks if this player is the neutral player.
`boolean`	`isObserver()` Checks if the player is an observer player, typically in a @UMS observer game.
`boolean`	`isResearchAvailable(TechType tech)` Checks if a technology can be researched by the player.
`boolean`	`isResearching(TechType tech)` Checks if the player is researching a given technology type.
`boolean`	`isUnitAvailable(UnitType unit)` Checks if a unit type can be created by the player.
`boolean`	`isUpgrading(UpgradeType upgrade)` Checks if the player is upgrading a given upgrade type.
`boolean`	`isVictorious()` Checks if the player has achieved victory.
`int`	`killedUnitCount()`
`int`	`killedUnitCount(UnitType unit)` Retrieves the number units that the player has killed.
`boolean`	`leftGame()` Checks if the player has left the game.
`int`	`maxEnergy(UnitType unit)` Retrieves the maximum amount of energy that a unit type will have, taking the player's energy upgrades into consideration.
`int`	`minerals()` Retrieves the current amount of minerals/ore that this player has.
`int`	`refundedGas()` Retrieves the cumulative amount of vespene gas that this player has gained from refunding (cancelling) units and structures.
`int`	`refundedMinerals()` Retrieves the cumulative amount of minerals/ore that this player has gained from refunding (cancelling) units and structures.
`int`	`repairedGas()` Retrieves the cumulative amount of vespene gas that this player has spent on repairing units since the beginning of the game.
`int`	`repairedMinerals()` Retrieves the cumulative amount of minerals/ore that this player has spent on repairing units since the beginning of the game.
`int`	`sightRange(UnitType unit)` Retrieves the sight range of a unit type, taking the player's sight range upgrades into consideration.
`int`	`spentGas()` Retrieves the cumulative amount of vespene gas that this player has spent, excluding repairs.
`int`	`spentMinerals()` Retrieves the cumulative amount of minerals/ore that this player has spent, excluding repairs.
`int`	`supplyTotal()`
`int`	`supplyTotal(Race race)` Retrieves the total amount of supply the player has available for unit control.
`int`	`supplyUsed()`
`int`	`supplyUsed(Race race)` Retrieves the current amount of supply that the player is using for unit control.
`double`	`topSpeed(UnitType unit)` Retrieves the top speed of a unit type, taking the player's speed upgrades into consideration.
`int`	`visibleUnitCount()`
`int`	`visibleUnitCount(UnitType unit)` Retrieves the total number of strictly visible units that the player has, even if information on the player is unrestricted.
`int`	`weaponDamageCooldown(UnitType unit)` Retrieves the weapon cooldown of a unit type, taking the player's attack speed upgrades into consideration.
`int`	`weaponMaxRange(WeaponType weapon)` Retrieves the maximum weapon range of a weapon type, taking the player's weapon upgrades into consideration.

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

- Method Detail
  - getID
```
public int getID()
```
    Retrieves a unique ID that represents the player.
    
    Returns:
    
    An integer representing the ID of the player.
  - getName
```
public String getName()
```
    Retrieves the name of the player.
    
    Returns:
    
    A String object containing the player's name.
  - getUnits
```
public List<Unit> getUnits()
```
    Retrieves the set of all units that the player owns. This also includes incomplete units.
    
    Returns:
    
    Reference to a List containing the units.
    This does not include units that are loaded into transports, @Bunkers, @Refineries, @Assimilators, or @Extractors.
  - getRace
```
public Race getRace()
```
    Retrieves the race of the player. This allows you to change strategies against different races, or generalize some commands for yourself.
    
    Returns:
    
    The Race that the player is using. Returns Race.Unknown if the player chose Race.Random when the game started and they have not been seen.
  - getType
```
public PlayerType getType()
```
    Retrieves the player's controller type. This allows you to distinguish betweeen computer and human players.
    
    Returns:
    
    The PlayerType that identifies who is controlling a player.
    Other players using BWAPI will be treated as a human player and return PlayerType.Player.
  - getForce
```
public Force getForce()
```
    Retrieves the player's force. A force is the team that the player is playing on.
    
    Returns:
    
    The Force object that the player is part of.
  - isAlly
```
public boolean isAlly(Player player)
```
    Checks if this player is allied to the specified player.
    
    Parameters:
    
    player - The player to check alliance with. Returns true if this player is allied with player, false if this player is not allied with player.
    This function will also return false if this player is neutral or an observer, or if player is neutral or an observer.
    
    See Also:
    
    isEnemy(bwapi.Player)
  - isEnemy
```
public boolean isEnemy(Player player)
```
    Checks if this player is unallied to the specified player.
    
    Parameters:
    
    player - The player to check alliance with.
    
    Returns:
    
    true if this player is allied with player, false if this player is not allied with player .
    This function will also return false if this player is neutral or an observer, or if player is neutral or an observer.
    
    See Also:
    
    isAlly(bwapi.Player)
  - isNeutral
```
public boolean isNeutral()
```
    Checks if this player is the neutral player.
    
    Returns:
    
    true if this player is the neutral player, false if this player is any other player.
  - getStartLocation
```
public TilePosition getStartLocation()
```
    Retrieve's the player's starting location.
    
    Returns:
    
    A TilePosition containing the position of the start location. Returns TilePosition.None if the player does not have a start location. Returns TilePosition.Unknown if an error occured while trying to retrieve the start location.
    
    See Also:
    
    Game.getStartLocations()
  - isVictorious
```
public boolean isVictorious()
```
    Checks if the player has achieved victory.
    
    Returns:
    
    true if this player has achieved victory, otherwise false
  - isDefeated
```
public boolean isDefeated()
```
    Checks if the player has been defeated.
    
    Returns:
    
    true if the player is defeated, otherwise false
  - leftGame
```
public boolean leftGame()
```
    Checks if the player has left the game.
    
    Returns:
    
    true if the player has left the game, otherwise false
  - minerals
```
public int minerals()
```
    Retrieves the current amount of minerals/ore that this player has.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Amount of minerals that the player currently has for spending.
  - gas
```
public int gas()
```
    Retrieves the current amount of vespene gas that this player has.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Amount of gas that the player currently has for spending.
  - gatheredMinerals
```
public int gatheredMinerals()
```
    Retrieves the cumulative amount of minerals/ore that this player has gathered since the beginning of the game, including the amount that the player starts the game with (if any).
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of minerals that the player has gathered.
  - gatheredGas
```
public int gatheredGas()
```
    Retrieves the cumulative amount of vespene gas that this player has gathered since the beginning of the game, including the amount that the player starts the game with (if any).
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of gas that the player has gathered.
  - repairedMinerals
```
public int repairedMinerals()
```
    Retrieves the cumulative amount of minerals/ore that this player has spent on repairing units since the beginning of the game. This function only applies to @Terran players.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of minerals that the player has spent repairing.
  - repairedGas
```
public int repairedGas()
```
    Retrieves the cumulative amount of vespene gas that this player has spent on repairing units since the beginning of the game. This function only applies to @Terran players.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of gas that the player has spent repairing.
  - refundedMinerals
```
public int refundedMinerals()
```
    Retrieves the cumulative amount of minerals/ore that this player has gained from refunding (cancelling) units and structures.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of minerals that the player has received from refunds.
  - refundedGas
```
public int refundedGas()
```
    Retrieves the cumulative amount of vespene gas that this player has gained from refunding (cancelling) units and structures.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of gas that the player has received from refunds.
  - spentMinerals
```
public int spentMinerals()
```
    Retrieves the cumulative amount of minerals/ore that this player has spent, excluding repairs.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of minerals that the player has spent.
  - spentGas
```
public int spentGas()
```
    Retrieves the cumulative amount of vespene gas that this player has spent, excluding repairs.
    This function will return 0 if the player is inaccessible.
    
    Returns:
    
    Cumulative amount of gas that the player has spent.
  - supplyTotal
```
public int supplyTotal()
```
  - supplyTotal
```
public int supplyTotal(Race race)
```
    Retrieves the total amount of supply the player has available for unit control.
    In Starcraft programming, the managed supply values are double than what they appear in the game. The reason for this is because @Zerglings use 0.5 visible supply.
    In Starcraft, the supply for each race is separate. Having a @Pylon and an @Overlord will not give you 32 supply. It will instead give you 16 @Protoss supply and 16 @Zerg supply.
    
    Parameters:
    
    race - The race to query the total supply for. If this is omitted, then the player's current race will be used.
    
    Returns:
    
    The total supply available for this player and the given race.
    
    See Also:
    
    supplyUsed()
  - supplyUsed
```
public int supplyUsed()
```
  - supplyUsed
```
public int supplyUsed(Race race)
```
    Retrieves the current amount of supply that the player is using for unit control.
    
    Parameters:
    
    race - The race to query the used supply for. If this is omitted, then the player's current race will be used.
    
    Returns:
    
    The supply that is in use for this player and the given race.
    
    See Also:
    
    supplyTotal()
  - allUnitCount
```
public int allUnitCount()
```
  - allUnitCount
```
public int allUnitCount(UnitType unit)
```
    Retrieves the total number of units that the player has. If the information about the player is limited, then this function will only return the number of visible units.
    While in-progress @Protoss and @Terran units will be counted, in-progress @Zerg units (i.e. inside of an egg) do not.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The total number of units of the given type that the player owns.
    
    See Also:
    
    visibleUnitCount(), completedUnitCount(), incompleteUnitCount()
  - visibleUnitCount
```
public int visibleUnitCount()
```
  - visibleUnitCount
```
public int visibleUnitCount(UnitType unit)
```
    Retrieves the total number of strictly visible units that the player has, even if information on the player is unrestricted.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The total number of units of the given type that the player owns, and is visible to the BWAPI player.
    
    See Also:
    
    allUnitCount(), completedUnitCount(), incompleteUnitCount()
  - completedUnitCount
```
public int completedUnitCount()
```
  - completedUnitCount
```
public int completedUnitCount(UnitType unit)
```
    Retrieves the number of completed units that the player has. If the information about the player is limited, then this function will only return the number of visible completed units.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The number of completed units of the given type that the player owns.
    
    See Also:
    
    allUnitCount(), visibleUnitCount(), incompleteUnitCount()
  - incompleteUnitCount
```
public int incompleteUnitCount()
```
  - incompleteUnitCount
```
public int incompleteUnitCount(UnitType unit)
```
    Retrieves the number of incomplete units that the player has. If the information about the player is limited, then this function will only return the number of visible incomplete units.
    This function is a macro for allUnitCount() - completedUnitCount().
    Incomplete @Zerg units inside of eggs are not counted.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The number of incomplete units of the given type that the player owns.
    
    See Also:
    
    allUnitCount(), visibleUnitCount(), completedUnitCount()
  - deadUnitCount
```
public int deadUnitCount()
```
  - deadUnitCount
```
public int deadUnitCount(UnitType unit)
```
    Retrieves the number units that have died for this player.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The total number of units that have died throughout the game.
  - killedUnitCount
```
public int killedUnitCount()
```
  - killedUnitCount
```
public int killedUnitCount(UnitType unit)
```
    Retrieves the number units that the player has killed.
    
    Parameters:
    
    unit - The unit type to query. UnitType macros are accepted. If this parameter is omitted, then it will use UnitType.AllUnits by default.
    
    Returns:
    
    The total number of units that the player has killed throughout the game.
  - getUpgradeLevel
```
public int getUpgradeLevel(UpgradeType upgrade)
```
    Retrieves the current upgrade level that the player has attained for a given upgrade type.
    
    Parameters:
    
    upgrade - The UpgradeType to query.
    
    Returns:
    
    The number of levels that the upgrade has been upgraded for this player.
    
    See Also:
    
    Unit.upgrade(bwapi.UpgradeType), getMaxUpgradeLevel(bwapi.UpgradeType)
  - hasResearched
```
public boolean hasResearched(TechType tech)
```
    Checks if the player has already researched a given technology.
    
    Parameters:
    
    tech - The TechType to query.
    
    Returns:
    
    true if the player has obtained the given tech, or false if they have not
    
    See Also:
    
    isResearching(bwapi.TechType), Unit.research(bwapi.TechType), isResearchAvailable(bwapi.TechType)
  - isResearching
```
public boolean isResearching(TechType tech)
```
    Checks if the player is researching a given technology type.
    
    Parameters:
    
    tech - The TechType to query.
    
    Returns:
    
    true if the player is currently researching the tech, or false otherwise
    
    See Also:
    
    Unit.research(bwapi.TechType), hasResearched(bwapi.TechType)
  - isUpgrading
```
public boolean isUpgrading(UpgradeType upgrade)
```
    Checks if the player is upgrading a given upgrade type.
    
    Parameters:
    
    upgrade - The upgrade type to query.
    
    Returns:
    
    true if the player is currently upgrading the given upgrade, false otherwise
    
    See Also:
    
    Unit.upgrade(bwapi.UpgradeType)
  - getColor
```
public Color getColor()
```
    Retrieves the color value of the current player.
    
    Returns:
    
    Color object that represents the color of the current player.
  - getTextColor
```
public Text getTextColor()
```
    Retrieves the control code character that changes the color of text messages to represent this player.
    
    Returns:
    
    character code to use for text in Broodwar.
  - maxEnergy
```
public int maxEnergy(UnitType unit)
```
    Retrieves the maximum amount of energy that a unit type will have, taking the player's energy upgrades into consideration.
    
    Parameters:
    
    unit - The UnitType to retrieve the maximum energy for.
    
    Returns:
    
    Maximum amount of energy that the given unit type can have.
  - topSpeed
```
public double topSpeed(UnitType unit)
```
    Retrieves the top speed of a unit type, taking the player's speed upgrades into consideration.
    
    Parameters:
    
    unit - The UnitType to retrieve the top speed for.
    
    Returns:
    
    Top speed of the provided unit type for this player.
  - weaponMaxRange
```
public int weaponMaxRange(WeaponType weapon)
```
    Retrieves the maximum weapon range of a weapon type, taking the player's weapon upgrades into consideration.
    
    Parameters:
    
    weapon - The WeaponType to retrieve the maximum range for.
    
    Returns:
    
    Maximum range of the given weapon type for units owned by this player.
  - sightRange
```
public int sightRange(UnitType unit)
```
    Retrieves the sight range of a unit type, taking the player's sight range upgrades into consideration.
    
    Parameters:
    
    unit - The UnitType to retrieve the sight range for.
    
    Returns:
    
    Sight range of the provided unit type for this player.
  - weaponDamageCooldown
```
public int weaponDamageCooldown(UnitType unit)
```
    Retrieves the weapon cooldown of a unit type, taking the player's attack speed upgrades into consideration.
    
    Parameters:
    
    unit - The UnitType to retrieve the damage cooldown for.
    
    Returns:
    
    Weapon cooldown of the provided unit type for this player.
  - armor
```
public int armor(UnitType unit)
```
    Calculates the armor that a given unit type will have, including upgrades.
    
    Parameters:
    
    unit - The unit type to calculate armor for, using the current player's upgrades.
    
    Returns:
    
    The amount of armor that the unit will have with the player's upgrades.
  - damage
```
public int damage(WeaponType wpn)
```
    Calculates the damage that a given weapon type can deal, including upgrades.
    
    Parameters:
    
    wpn - The weapon type to calculate for.
    
    Returns:
    
    The amount of damage that the weapon deals with this player's upgrades.
  - getUnitScore
```
public int getUnitScore()
```
    Retrieves the total unit score, as seen in the end-game score screen.
    
    Returns:
    
    The player's unit score.
  - getKillScore
```
public int getKillScore()
```
    Retrieves the total kill score, as seen in the end-game score screen.
    
    Returns:
    
    The player's kill score.
  - getBuildingScore
```
public int getBuildingScore()
```
    Retrieves the total building score, as seen in the end-game score screen.
    
    Returns:
    
    The player's building score.
  - getRazingScore
```
public int getRazingScore()
```
    Retrieves the total razing score, as seen in the end-game score screen.
    
    Returns:
    
    The player's razing score.
  - getCustomScore
```
public int getCustomScore()
```
    Retrieves the player's custom score. This score is used in @UMS game types.
    
    Returns:
    
    The player's custom score.
  - isObserver
```
public boolean isObserver()
```
    Checks if the player is an observer player, typically in a @UMS observer game. An observer player does not participate in the game.
    
    Returns:
    
    true if the player is observing, or false if the player is capable of playing in the game.
  - getMaxUpgradeLevel
```
public int getMaxUpgradeLevel(UpgradeType upgrade)
```
    Retrieves the maximum upgrades available specific to the player. This value is only different from UpgradeType#maxRepeats in @UMS games.
    
    Parameters:
    
    upgrade - The UpgradeType to retrieve the maximum upgrade level for.
    
    Returns:
    
    Maximum upgrade level of the given upgrade type.
  - isResearchAvailable
```
public boolean isResearchAvailable(TechType tech)
```
    Checks if a technology can be researched by the player. Certain technologies may be disabled in @UMS game types.
    
    Parameters:
    
    tech - The TechType to query.
    
    Returns:
    
    true if the tech type is available to the player for research.
  - isUnitAvailable
```
public boolean isUnitAvailable(UnitType unit)
```
    Checks if a unit type can be created by the player. Certain unit types may be disabled in @UMS game types.
    
    Parameters:
    
    unit - The UnitType to check.
    
    Returns:
    
    true if the unit type is available to the player.
  - hasUnitTypeRequirement
```
public boolean hasUnitTypeRequirement(UnitType unit)
```
  - hasUnitTypeRequirement
```
public boolean hasUnitTypeRequirement(UnitType unit,
                                      int amount)
```
    Verifies that this player satisfies a unit type requirement. This verifies complex type requirements involving morphable @Zerg structures. For example, if something requires a @Spire, but the player has (or is in the process of morphing) a @Greater_Spire, this function will identify the requirement. It is simply a convenience function that performs all of the requirement checks.
    
    Parameters:
    
    unit - The UnitType to check.
    
    amount - The amount of units that are required.
    
    Returns:
    
    true if the unit type requirements are met, and false otherwise.
    
    Since:
    
    4.1.2
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Player other)
```
    Specified by:
    
    compareTo in interface Comparable<Player>

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

allUnitCount

visibleUnitCount

visibleUnitCount

completedUnitCount

completedUnitCount

incompleteUnitCount

incompleteUnitCount

deadUnitCount

deadUnitCount

killedUnitCount

killedUnitCount

getUpgradeLevel

hasResearched

isResearching

isUpgrading

getColor

getTextColor

maxEnergy

topSpeed

weaponMaxRange

sightRange

weaponDamageCooldown

armor

damage

getUnitScore

getKillScore

getBuildingScore

getRazingScore

getCustomScore

isObserver

getMaxUpgradeLevel

isResearchAvailable

isUnitAvailable

hasUnitTypeRequirement

hasUnitTypeRequirement

equals

hashCode

compareTo