BWAPI::UpgradeType Class Reference

#include <UpgradeType.h>

List of all members.

Public Member Functions
	UpgradeType ()
	UpgradeType (int id)
	UpgradeType (const UpgradeType &other)
UpgradeType &	operator= (const UpgradeType &other)
	operator int () const
int	getID () const
std::string	getName () 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
Private Attributes
int	id

---

Detailed Description

Definition at line 8 of file UpgradeType.h.

---

Constructor & Destructor Documentation

BWAPI::UpgradeType::UpgradeType

(

)

BWAPI::UpgradeType::UpgradeType

(

int

id

)

BWAPI::UpgradeType::UpgradeType

(

const UpgradeType &

other

)

---

Member Function Documentation

int BWAPI::UpgradeType::gasPrice

(

int

level = 1

)

const

Returns the vespene gas price for the first upgrade.

Referenced by UpgradeTask::giveUnit(), UpgradeTask::returnUnit(), UpgradeTask::update(), and UpgradeTask::updateRequirements().

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.

int BWAPI::UpgradeType::getID

(

)

const

Returns the unique ID for this upgrade type.

std::string BWAPI::UpgradeType::getName

(

)

const

Returns the name for the upgrade type.

Referenced by MacroItem::getDebugInfo(), and UpgradeTask::getOutputName().

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.

int BWAPI::UpgradeType::maxRepeats

(

)

const

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

Referenced by MacroManagerClass::onChangeBuild().

Here is the caller graph for this function:

int BWAPI::UpgradeType::mineralPrice

(

int

level = 1

)

const

Returns the mineral price for the first upgrade.

Referenced by UpgradeTask::giveUnit(), UpgradeTask::returnUnit(), UpgradeTask::update(), and UpgradeTask::updateRequirements().

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.

BWAPI::UpgradeType::operator int

(

)

const

UpgradeType& BWAPI::UpgradeType::operator=

(

const UpgradeType &

other

)

int BWAPI::UpgradeType::upgradeTime

(

int

level = 1

)

const

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

Referenced by UpgradeTask::getEndTime(), and UpgradeTask::updateRequirements().

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.

UnitType BWAPI::UpgradeType::whatsRequired

(

int

level = 1

)

const

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

UnitType BWAPI::UpgradeType::whatUpgrades

(

)

const

Returns the type of unit that researches the upgrade.

Referenced by Requirement::earliestTime(), MacroManagerClass::getNeededUnits(), UpgradeTask::giveUnit(), MacroManagerClass::hasRequirements(), MacroManagerClass::onUpgradeTask(), and UpgradeTask::updateRequirements().

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.

---

Member Data Documentation

int BWAPI::UpgradeType::id [private]

Definition at line 57 of file UpgradeType.h.

---

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

• Skynet/include/BWAPI/UpgradeType.h