BWAPI::PlayerImpl Class Reference

#include <PlayerImpl.h>

Inheritance diagram for BWAPI::PlayerImpl:

Collaboration diagram for BWAPI::PlayerImpl:

List of all members.

Public Member Functions
virtual int	getID () const
virtual std::string	getName () const
virtual Race	getRace () const
virtual PlayerType	getType () const
virtual Force *	getForce () const
virtual bool	isAlly (Player *player) const
virtual bool	isEnemy (Player *player) const
virtual bool	isNeutral () const
virtual bool	isVictorious () const
virtual bool	isDefeated () const
virtual bool	leftGame () const
virtual const std::set< Unit * > &	getUnits () const
virtual TilePosition	getStartLocation () const
virtual int	minerals () const
virtual int	gas () const
virtual int	gatheredMinerals () const
virtual int	gatheredGas () const
virtual int	repairedMinerals () const
virtual int	repairedGas () const
virtual int	refundedMinerals () const
virtual int	refundedGas () const
virtual int	spentMinerals () const
virtual int	spentGas () const
virtual int	supplyTotal () const
virtual int	supplyUsed () const
virtual int	supplyTotal (Race race) const
virtual int	supplyUsed (Race race) const
virtual int	allUnitCount (UnitType unit) const
virtual int	visibleUnitCount (UnitType unit) const
virtual int	completedUnitCount (UnitType unit) const
virtual int	incompleteUnitCount (UnitType unit) const
virtual int	deadUnitCount (UnitType unit) const
virtual int	killedUnitCount (UnitType unit) const
virtual int	getUpgradeLevel (UpgradeType upgrade) const
virtual bool	hasResearched (TechType tech) const
virtual bool	isResearching (TechType tech) const
virtual bool	isUpgrading (UpgradeType upgrade) const
virtual BWAPI::Color	getColor () const
virtual int	getTextColor () const
virtual int	maxEnergy (UnitType unit) const
virtual double	topSpeed (UnitType unit) const
virtual int	groundWeaponMaxRange (UnitType unit) const
virtual int	airWeaponMaxRange (UnitType unit) const
virtual int	weaponMaxRange (WeaponType weapon) const
virtual int	sightRange (UnitType unit) const
virtual int	groundWeaponDamageCooldown (UnitType unit) const
virtual int	armor (UnitType unit) const
virtual int	getUnitScore () const
virtual int	getKillScore () const
virtual int	getBuildingScore () const
virtual int	getRazingScore () const
virtual int	getCustomScore () const
virtual bool	isObserver () const
virtual int	getMaxUpgradeLevel (UpgradeType upgrade) const
virtual bool	isResearchAvailable (TechType tech) const
virtual bool	isUnitAvailable (UnitType unit) const
	PlayerImpl (u8 index)
	~PlayerImpl ()
int	getIndex () const
char *	getForceName () const
void	setID (int newID)
BW::Unit **	selectedUnit ()
void	updateData ()
void	onGameEnd ()
void	setParticipating (bool isParticipating=true)
void	resetResources ()
void	clear ()
	PlayerImpl (int id)
virtual int	getID () const
virtual std::string	getName () const
virtual const std::set< Unit * > &	getUnits () const
virtual Race	getRace () const
virtual PlayerType	getType () const
virtual Force *	getForce () const
virtual bool	isAlly (Player *player) const
virtual bool	isEnemy (Player *player) const
virtual bool	isNeutral () const
virtual TilePosition	getStartLocation () const
virtual bool	isVictorious () const
virtual bool	isDefeated () const
virtual bool	leftGame () const
virtual int	minerals () const
virtual int	gas () const
virtual int	gatheredMinerals () const
virtual int	gatheredGas () const
virtual int	repairedMinerals () const
virtual int	repairedGas () const
virtual int	refundedMinerals () const
virtual int	refundedGas () const
virtual int	spentMinerals () const
virtual int	spentGas () const
virtual int	supplyTotal () const
virtual int	supplyUsed () const
virtual int	supplyTotal (Race race) const
virtual int	supplyUsed (Race race) const
virtual int	allUnitCount (UnitType unit) const
virtual int	visibleUnitCount (UnitType unit) const
virtual int	completedUnitCount (UnitType unit) const
virtual int	incompleteUnitCount (UnitType unit) const
virtual int	deadUnitCount (UnitType unit) const
virtual int	killedUnitCount (UnitType unit) const
virtual int	getUpgradeLevel (UpgradeType upgrade) const
virtual bool	hasResearched (TechType tech) const
virtual bool	isResearching (TechType tech) const
virtual bool	isUpgrading (UpgradeType upgrade) const
virtual BWAPI::Color	getColor () const
virtual int	getTextColor () const
virtual int	maxEnergy (UnitType unit) const
virtual double	topSpeed (UnitType unit) const
virtual int	groundWeaponMaxRange (UnitType unit) const
virtual int	airWeaponMaxRange (UnitType unit) const
virtual int	weaponMaxRange (WeaponType weapon) const
virtual int	sightRange (UnitType unit) const
virtual int	groundWeaponDamageCooldown (UnitType unit) const
virtual int	armor (UnitType unit) const
virtual int	getUnitScore () const
virtual int	getKillScore () const
virtual int	getBuildingScore () const
virtual int	getRazingScore () const
virtual int	getCustomScore () const
virtual bool	isObserver () const
virtual int	getMaxUpgradeLevel (UpgradeType upgrade) const
virtual bool	isResearchAvailable (TechType tech) const
virtual bool	isUnitAvailable (UnitType unit) const
Public Attributes
ForceImpl *	force
PlayerData	data
PlayerData *	self
std::set< Unit * >	units
s32	_repairedMinerals
s32	_repairedGas
s32	_refundedMinerals
s32	_refundedGas
bool	wasSeenByBWAPIPlayer

---

Detailed Description

Represents one player in game. Note that there is always player 12 who owns resources.

---

Constructor & Destructor Documentation

BWAPI::PlayerImpl::PlayerImpl

(

u8

index

)

Constructs new player

Parameters:

id	0-based Index of the player (11 for resources as it is player 12)

Here is the call graph for this function:

BWAPI::PlayerImpl::~PlayerImpl

(

)

BWAPI::PlayerImpl::PlayerImpl

(

int

id

)

Here is the call graph for this function:

---

Member Function Documentation

virtual int BWAPI::PlayerImpl::airWeaponMaxRange

(

UnitType

unit

)

const [virtual]

Returns the max air weapon range of the given unit type, includes upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::airWeaponMaxRange

(

UnitType

unit

)

const [virtual]

Returns the max air weapon range of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

virtual int BWAPI::PlayerImpl::allUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of all accessible units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::allUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of all accessible units of the given type.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::armor

(

UnitType

unit

)

const [virtual]

Returns the armor of the given unit type, includes upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::armor

(

UnitType

unit

)

const [virtual]

Returns the armor of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

void BWAPI::PlayerImpl::clear

(

)

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::completedUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of completed units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::completedUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of completed units of the given type.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::deadUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of dead units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::deadUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of dead units of the given type.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::gas

(

)

const [virtual]

Returns the amount of vespene gas the player has.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::gas

(

)

const [virtual]

Returns the amount of vespene gas the player has.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::gatheredGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has harvested up to this point.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::gatheredGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has harvested up to this point.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::gatheredMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has mined up to this point (including the 50 minerals at the start of the game).

Implements BWAPI::Player.

int BWAPI::PlayerImpl::gatheredMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has mined up to this point (including the 50 minerals at the start of the game).

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::getBuildingScore

(

)

const [virtual]

Returns the Player's Total Buildings Score

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getBuildingScore

(

)

const [virtual]

Returns the Player's Total Buildings Score

Implements BWAPI::Player.

virtual BWAPI::Color BWAPI::PlayerImpl::getColor

(

)

const [virtual]

Returns the color of the player for drawing

Implements BWAPI::Player.

BWAPI::Color BWAPI::PlayerImpl::getColor

(

)

const [virtual]

Returns the color of the player for drawing

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::getCustomScore

(

)

const [virtual]

Returns the Player's Custom Score

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getCustomScore

(

)

const [virtual]

Returns the Player's Custom Score

Implements BWAPI::Player.

virtual Force* BWAPI::PlayerImpl::getForce

(

)

const [virtual]

Returns the force the player is on.

Implements BWAPI::Player.

Force * BWAPI::PlayerImpl::getForce

(

)

const [virtual]

Returns the force the player is on.

Implements BWAPI::Player.

char * BWAPI::PlayerImpl::getForceName

(

)

const

Gets 0-based index of the player. (11 for neutral)

virtual int BWAPI::PlayerImpl::getID

(

)

const [virtual]

Returns a unique ID for the player.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getID

(

)

const [virtual]

Gets the name of the player

Returns:

Pointer directly to bw memory where the name is represented.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getIndex

(

)

const

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::getKillScore

(

)

const [virtual]

Returns the Player's Total Kill Score

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getKillScore

(

)

const [virtual]

Returns the Player's Total Kill Score

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::getMaxUpgradeLevel

(

UpgradeType

upgrade

)

const [virtual]

Returns the maximum upgrades available specific to the player (Use Map Settings).

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getMaxUpgradeLevel

(

UpgradeType

upgrade

)

const [virtual]

Returns the maximum upgrades available specific to the player (Use Map Settings).

Implements BWAPI::Player.

virtual std::string BWAPI::PlayerImpl::getName

(

)

const [virtual]

Returns the name of the player.

Implements BWAPI::Player.

std::string BWAPI::PlayerImpl::getName

(

)

const [virtual]

Returns the name of the player.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual Race BWAPI::PlayerImpl::getRace

(

)

const [virtual]

Returns the race of the player.

Implements BWAPI::Player.

Race BWAPI::PlayerImpl::getRace

(

)

const [virtual]

Returns the race of the player.

Implements BWAPI::Player.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::getRazingScore

(

)

const [virtual]

Returns the Player's Total Razings Score

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getRazingScore

(

)

const [virtual]

Returns the Player's Total Razings Score

Implements BWAPI::Player.

virtual TilePosition BWAPI::PlayerImpl::getStartLocation

(

)

const [virtual]

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.

Implements BWAPI::Player.

TilePosition BWAPI::PlayerImpl::getStartLocation

(

)

const [virtual]

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.

Implements BWAPI::Player.

Here is the call graph for this function:

virtual int BWAPI::PlayerImpl::getTextColor

(

)

const [virtual]

Returns the color of the player for text messages

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getTextColor

(

)

const [virtual]

Returns the color of the player for text messages

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual PlayerType BWAPI::PlayerImpl::getType

(

)

const [virtual]

Returns the type of the player.

Implements BWAPI::Player.

PlayerType BWAPI::PlayerImpl::getType

(

)

const [virtual]

Returns the type of the player.

Implements BWAPI::Player.

virtual const std::set<Unit*>& BWAPI::PlayerImpl::getUnits

(

)

const [virtual]

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.

Implements BWAPI::Player.

const std::set< Unit * > & BWAPI::PlayerImpl::getUnits

(

)

const [virtual]

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.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::getUnitScore

(

)

const [virtual]

Returns the Player's Total Unit Score

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getUnitScore

(

)

const [virtual]

Returns the Player's Total Unit Score

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::getUpgradeLevel

(

UpgradeType

upgrade

)

const [virtual]

Returns the player's current upgrade level of the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::getUpgradeLevel

(

UpgradeType

upgrade

)

const [virtual]

Returns the player's current upgrade level of the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::groundWeaponDamageCooldown

(

UnitType

unit

)

const [virtual]

Returns the ground weapon cooldown of the given unit type, includes upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::groundWeaponDamageCooldown

(

UnitType

unit

)

const [virtual]

Returns the ground weapon cooldown of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

virtual int BWAPI::PlayerImpl::groundWeaponMaxRange

(

UnitType

unit

)

const [virtual]

Returns the max ground weapon range of the given unit type, includes upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::groundWeaponMaxRange

(

UnitType

unit

)

const [virtual]

Returns the max ground weapon range of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

virtual bool BWAPI::PlayerImpl::hasResearched

(

TechType

tech

)

const [virtual]

Returns true if the player has finished researching the given tech. To order a unit to research a given tech type, see Unit::research.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::hasResearched

(

TechType

tech

)

const [virtual]

Returns true if the player has finished researching the given tech. To order a unit to research a given tech type, see Unit::research.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::incompleteUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of incomplete units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::incompleteUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of incomplete units of the given type.

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::isAlly

(

Player *

player

)

const [virtual]

Returns true if other player is an ally of this player.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isAlly

(

Player *

player

)

const [virtual]

Returns true if other player is an ally of this player.

Implements BWAPI::Player.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool BWAPI::PlayerImpl::isDefeated

(

)

const [virtual]

Returns true if the player has been defeated.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isDefeated

(

)

const [virtual]

Returns true if the player has been defeated.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual bool BWAPI::PlayerImpl::isEnemy

(

Player *

player

)

const [virtual]

Returns true if other player is an enemy of this player.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isEnemy

(

Player *

player

)

const [virtual]

Returns true if other player is an enemy of this player.

Implements BWAPI::Player.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual bool BWAPI::PlayerImpl::isNeutral

(

)

const [virtual]

Returns true if the player is the neutral player.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isNeutral

(

)

const [virtual]

Returns true if the player is the neutral player.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual bool BWAPI::PlayerImpl::isObserver

(

)

const [virtual]

Returns true if the Player is only observing the game, and not participating

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isObserver

(

)

const [virtual]

Returns true if the Player is only observing the game, and not participating

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual bool BWAPI::PlayerImpl::isResearchAvailable

(

TechType

tech

)

const [virtual]

Returns true if the research is available for the player to research (Use Map Settings).

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isResearchAvailable

(

TechType

tech

)

const [virtual]

Returns true if the research is available for the player to research (Use Map Settings).

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::isResearching

(

TechType

tech

)

const [virtual]

Returns true if the player is researching the given tech. To order a unit to research a given tech type, see Unit::reseach.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isResearching

(

TechType

tech

)

const [virtual]

Returns true if the player is researching the given tech. To order a unit to research a given tech type, see Unit::reseach.

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::isUnitAvailable

(

UnitType

unit

)

const [virtual]

Returns true if the unit is available for the player to build (Use Map Settings).

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isUnitAvailable

(

UnitType

unit

)

const [virtual]

Returns true if the unit is available for the player to build (Use Map Settings).

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::isUpgrading

(

UpgradeType

upgrade

)

const [virtual]

Returns true if the player is upgrading the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isUpgrading

(

UpgradeType

upgrade

)

const [virtual]

Returns true if the player is upgrading the given upgrade. To order a unit to upgrade a given upgrade type, see Unit::upgrade.

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::isVictorious

(

)

const [virtual]

Returns true if the player has achieved victory.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::isVictorious

(

)

const [virtual]

Returns true if the player has achieved victory.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::killedUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of killed units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::killedUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of killed units of the given type.

Implements BWAPI::Player.

virtual bool BWAPI::PlayerImpl::leftGame

(

)

const [virtual]

Returns true if the player left the game.

Implements BWAPI::Player.

bool BWAPI::PlayerImpl::leftGame

(

)

const [virtual]

Returns true if the player left the game.

Implements BWAPI::Player.

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::maxEnergy

(

UnitType

unit

)

const [virtual]

Returns the max energy of the given unit type, taking into account upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::maxEnergy

(

UnitType

unit

)

const [virtual]

Returns the max energy of the given unit type, taking into account upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

virtual int BWAPI::PlayerImpl::minerals

(

)

const [virtual]

Returns the amount of minerals the player has.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::minerals

(

)

const [virtual]

Returns the amount of minerals the player has.

Implements BWAPI::Player.

void BWAPI::PlayerImpl::onGameEnd

(

)

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::refundedGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has gained from refunded units up to this point.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::refundedGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has gained from refunded units up to this point.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::refundedMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has gained from refunded units up to this point.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::refundedMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has gained from refunded units up to this point.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::repairedGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has spent on repairs up to this point.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::repairedGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has spent on repairs up to this point.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::repairedMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has spent on repairs up to this point.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::repairedMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has spent on repairs up to this point.

Implements BWAPI::Player.

void BWAPI::PlayerImpl::resetResources

(

)

Here is the caller graph for this function:

BW::Unit ** BWAPI::PlayerImpl::selectedUnit

(

)

Gets the bw mapping of synchronised version of selected unit for current player

void BWAPI::PlayerImpl::setID

(

int

newID

)

Here is the caller graph for this function:

void BWAPI::PlayerImpl::setParticipating

(

bool

isParticipating = true

)

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::sightRange

(

UnitType

unit

)

const [virtual]

Returns the sight range of the given unit type, includes upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::sightRange

(

UnitType

unit

)

const [virtual]

Returns the sight range of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

virtual int BWAPI::PlayerImpl::spentGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has spent up to this point (not including repairs).

Implements BWAPI::Player.

int BWAPI::PlayerImpl::spentGas

(

)

const [virtual]

Returns the cumulative amount of gas the player has spent up to this point (not including repairs).

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::spentMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has spent up to this point (not including repairs).

Implements BWAPI::Player.

int BWAPI::PlayerImpl::spentMinerals

(

)

const [virtual]

Returns the cumulative amount of minerals the player has spent up to this point (not including repairs).

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::supplyTotal

(

)

const [virtual]

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.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::supplyTotal

(

Race

race

)

const [virtual]

Implements BWAPI::Player.

int BWAPI::PlayerImpl::supplyTotal

(

)

const [virtual]

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.

Implements BWAPI::Player.

Here is the call graph for this function:

int BWAPI::PlayerImpl::supplyTotal

(

Race

race

)

const [virtual]

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::supplyUsed

(

)

const [virtual]

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.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::supplyUsed

(

Race

race

)

const [virtual]

Implements BWAPI::Player.

int BWAPI::PlayerImpl::supplyUsed

(

)

const [virtual]

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.

Implements BWAPI::Player.

Here is the call graph for this function:

int BWAPI::PlayerImpl::supplyUsed

(

Race

race

)

const [virtual]

Implements BWAPI::Player.

virtual double BWAPI::PlayerImpl::topSpeed

(

UnitType

unit

)

const [virtual]

Returns the top speed of the given unit type, includes upgrades

Implements BWAPI::Player.

double BWAPI::PlayerImpl::topSpeed

(

UnitType

unit

)

const [virtual]

Returns the top speed of the given unit type, includes upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

void BWAPI::PlayerImpl::updateData

(

)

Updates localData according to bw values. (Should be called every frame before local data updates are performed

Here is the call graph for this function:

Here is the caller graph for this function:

virtual int BWAPI::PlayerImpl::visibleUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of visible units of the given type.

Implements BWAPI::Player.

int BWAPI::PlayerImpl::visibleUnitCount

(

UnitType

unit

)

const [virtual]

Returns the number of visible units of the given type.

Implements BWAPI::Player.

virtual int BWAPI::PlayerImpl::weaponMaxRange

(

WeaponType

weapon

)

const [virtual]

Returns the max range of the given weapon with upgrades

Implements BWAPI::Player.

int BWAPI::PlayerImpl::weaponMaxRange

(

WeaponType

weapon

)

const [virtual]

Returns the max range of the given weapon with upgrades

Implements BWAPI::Player.

Here is the call graph for this function:

---

Member Data Documentation

s32 BWAPI::PlayerImpl::_refundedGas

s32 BWAPI::PlayerImpl::_refundedMinerals

s32 BWAPI::PlayerImpl::_repairedGas

s32 BWAPI::PlayerImpl::_repairedMinerals

PlayerData BWAPI::PlayerImpl::data

ForceImpl* BWAPI::PlayerImpl::force

PlayerData * BWAPI::PlayerImpl::self

std::set< Unit * > BWAPI::PlayerImpl::units

bool BWAPI::PlayerImpl::wasSeenByBWAPIPlayer

---

The documentation for this class was generated from the following files:

• trunk/bwapi/BWAPI/Source/BWAPI/PlayerImpl.h
• trunk/bwapi/include/BWAPI/Client/PlayerImpl.h
• trunk/bwapi/BWAPI/Source/BWAPI/PlayerImpl.cpp
• trunk/bwapi/BWAPIClient/Source/PlayerImpl.cpp
• trunk/bwapi/Shared/PlayerShared.cpp