BWAPI::UpgradeType Class Reference

#include <UpgradeType.h>

Inheritance diagram for BWAPI::UpgradeType:

Collaboration diagram for BWAPI::UpgradeType:

List of all members.

Public Member Functions
	UpgradeType ()
	UpgradeType (int id)
const std::string &	getName () const
const char *	c_str () const
Race	getRace () const
int	mineralPrice (int level=1) const
int	mineralPriceFactor () const
int	gasPrice (int level=1) const
int	gasPriceFactor () const
int	upgradeTime (int level=1) const
int	upgradeTimeFactor () const
int	maxRepeats () const
UnitType	whatUpgrades () const
UnitType	whatsRequired (int level=1) const
const std::set< UnitType > &	whatUses () const

---

Constructor & Destructor Documentation

BWAPI::UpgradeType::UpgradeType

(

)

BWAPI::UpgradeType::UpgradeType

(

int

id

)

---

Member Function Documentation

const char * BWAPI::UpgradeType::c_str

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::UpgradeType::gasPrice

(

int

level = 1

)

const

Returns the vespene gas price for the first upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::UpgradeType::gasPriceFactor

(

)

const

Returns the amount that the vespene gas price increases for each additional upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string & BWAPI::UpgradeType::getName

(

)

const

Returns the name for the upgrade type.

Here is the call graph for this function:

Here is the caller graph for this function:

Race BWAPI::UpgradeType::getRace

(

)

const

Returns the race the upgrade is for. For example, UpgradeTypes::Terran_Infantry_Armor.getRace() will return Races::Terran.

Here is the call graph for this function:

int BWAPI::UpgradeType::maxRepeats

(

)

const

Returns the maximum number of times the upgrade can be researched.

Here is the call graph for this function:

int BWAPI::UpgradeType::mineralPrice

(

int

level = 1

)

const

Returns the mineral price for the first upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::UpgradeType::mineralPriceFactor

(

)

const

Returns the amount that the mineral price increases for each additional upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::UpgradeType::upgradeTime

(

int

level = 1

)

const

Returns the number of frames needed to research the first upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::UpgradeType::upgradeTimeFactor

(

)

const

Returns the number of frames that the upgrade time increases for each additional upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

UnitType BWAPI::UpgradeType::whatsRequired

(

int

level = 1

)

const

Returns the type of unit that is additionally required for the upgrade.

Here is the call graph for this function:

UnitType BWAPI::UpgradeType::whatUpgrades

(

)

const

Returns the type of unit that researches the upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

const std::set< UnitType > & BWAPI::UpgradeType::whatUses

(

)

const

Returns the set of units that are affected by this upgrade.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• trunk/bwapi/include/BWAPI/UpgradeType.h
• trunk/bwapi/BWAPILIB/Source/UpgradeType.cpp