Inheritance diagram for BWAPI::UnitType:

Public Member Functions
constexpr	UnitType (int id=UnitTypes::Enum::None)
const SetContainer< TechType > &	abilities () const
int	acceleration () const
WeaponType	airWeapon () const
int	armor () const
UpgradeType	armorUpgrade () const
int	buildScore () const
const UnitType::set &	buildsWhat () const
int	buildTime () const
bool	canAttack () const
bool	canBuildAddon () const
bool	canMove () const
bool	canProduce () const
TechType	cloakingTech () const
int	destroyScore () const
int	dimensionDown () const
int	dimensionLeft () const
int	dimensionRight () const
int	dimensionUp () const
int	gasPrice () const
Race	getRace () const
WeaponType	groundWeapon () const
int	haltDistance () const
bool	hasPermanentCloak () const
int	height () const
bool	isAddon () const
bool	isBeacon () const
bool	isBuilding () const
bool	isBurrowable () const
bool	isCloakable () const
bool	isCritter () const
bool	isDetector () const
bool	isFlagBeacon () const
bool	isFlyer () const
bool	isFlyingBuilding () const
bool	isHero () const
bool	isInvincible () const
bool	isMechanical () const
bool	isMineralField () const
bool	isNeutral () const
bool	isOrganic () const
bool	isPowerup () const
bool	isRefinery () const
bool	isResourceContainer () const
bool	isResourceDepot () const
bool	isRobotic () const
bool	isSpecialBuilding () const
bool	isSpell () const
bool	isSpellcaster () const
bool	isSuccessorOf (UnitType type) const
bool	isTwoUnitsInOneEgg () const
bool	isWorker () const
int	maxAirHits () const
int	maxEnergy () const
int	maxGroundHits () const
int	maxHitPoints () const
int	maxShields () const
int	mineralPrice () const
bool	producesCreep () const
bool	producesLarva () const
bool	regeneratesHP () const
TechType	requiredTech () const
const std::map< UnitType, int > &	requiredUnits () const
bool	requiresCreep () const
bool	requiresPsi () const
const SetContainer< TechType > &	researchesWhat () const
int	seekRange () const
int	sightRange () const
UnitSizeType	size () const
int	spaceProvided () const
int	spaceRequired () const
int	supplyProvided () const
int	supplyRequired () const
int	tileHeight () const
TilePosition	tileSize () const
int	tileWidth () const
double	topSpeed () const
int	turnRadius () const
const SetContainer< UpgradeType > &	upgrades () const
const SetContainer< UpgradeType > &	upgradesWhat () const
const std::pair< UnitType, int >	whatBuilds () const
int	width () const

Detailed Description

The UnitType is used to get information about a particular type of unit, such as its cost, build time, weapon, hit points, abilities, etc.

See also: UnitInterface::getType, UnitTypes

Constructor & Destructor Documentation

constexpr BWAPI::UnitType::UnitType (int id = UnitTypes::Enum::None)

Expected type constructor.

If the type is an invalid type, then it becomes Types::Unknown. A type is invalid if its value is less than 0 or greater than Types::Unknown.

Parameters

id	The id that corresponds to this type. It is typically an integer value that corresponds to an internal Broodwar type. If the given id is invalid, then it becomes Types::Unknown.

Member Function Documentation

Race BWAPI::UnitType::getRace () const

Retrieves the Race that the unit type belongs to.

Returns: Race indicating the race that owns this unit type.

Return values

Race::None indicating that the unit type does not belong to any particular race (a critter for example).

const std::pair< UnitType, int > BWAPI::UnitType::whatBuilds () const

Obtains the source unit type that is used to build or train this unit type, as well as the amount of them that are required.

Returns: std::pair in which the first value is the UnitType that builds this unit type, and the second value is the number of those types that are required (this value is 2 for Archons, and 1 for all other types).

Return values

pair(UnitTypes::None,0) If this unit type cannot be made by the player.

const std::map< UnitType, int >& BWAPI::UnitType::requiredUnits () const

Retrieves the immediate technology tree requirements to make this unit type.

Returns: std::map containing a UnitType to number mapping of UnitTypes required.

TechType BWAPI::UnitType::requiredTech () const

Identifies the required TechType in order to create certain units.

Note: The only unit that requires a technology is the Lurker, which needs Lurker Aspect.

Returns: TechType indicating the technology that must be researched in order to create this unit type.

Return values

TechTypes::None If creating this unit type does not require a technology to be researched.

TechType BWAPI::UnitType::cloakingTech () const

Retrieves the cloaking technology associated with certain units.

Returns: TechType referring to the cloaking technology that this unit type uses as an ability.

Return values

TechTypes::None If this unit type does not have an active cloak ability.

const SetContainer<TechType>& BWAPI::UnitType::abilities () const

Retrieves the set of abilities that this unit can use, provided it is available to you in the game.

Returns: Set of TechTypes containing ability information.

const SetContainer<UpgradeType>& BWAPI::UnitType::upgrades () const

Retrieves the set of upgrades that this unit can use to enhance its fighting ability.

Returns: Set of UpgradeTypes containing upgrade types that will impact this unit type.

UpgradeType BWAPI::UnitType::armorUpgrade () const

Retrieves the upgrade type used to increase the armor of this unit type.

For each upgrade, this unit type gains +1 additional armor.

Returns: UpgradeType indicating the upgrade that increases this unit type's armor amount.

int BWAPI::UnitType::maxHitPoints () const

Retrieves the default maximum amount of hit points that this unit type can have.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: Integer indicating the maximum amount of hit points for this unit type.

int BWAPI::UnitType::maxShields () const

Retrieves the default maximum amount of shield points that this unit type can have.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: Integer indicating the maximum amount of shield points for this unit type.

Return values

0	If this unit type does not have shields.

int BWAPI::UnitType::maxEnergy () const

Retrieves the maximum amount of energy this unit type can have by default.

Returns: Integer indicating the maximum amount of energy for this unit type.

Return values

0	If this unit does not gain energy for abilities.

int BWAPI::UnitType::armor () const

Retrieves the default amount of armor that the unit type starts with, excluding upgrades.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: The amount of armor the unit type has.

int BWAPI::UnitType::mineralPrice () const

Retrieves the default mineral price of purchasing the unit.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: Mineral cost of the unit.

int BWAPI::UnitType::gasPrice () const

Retrieves the default vespene gas price of purchasing the unit.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: Vespene gas cost of the unit.

int BWAPI::UnitType::buildTime () const

Retrieves the default time, in frames, needed to train, morph, or build the unit.

Note: This value may not necessarily match the value seen in the Use Map Settings game type.

Returns: Number of frames needed in order to build the unit.

See also: UnitInterface::getRemainingBuildTime

int BWAPI::UnitType::supplyRequired () const

Retrieves the amount of supply that this unit type will use when created.

It will use the supply pool that is appropriate for its Race.

Note: 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.

Returns: Integer containing the supply required to build this unit.

See also: supplyProvided, PlayerInterface::supplyTotal, PlayerInterface::supplyUsed

int BWAPI::UnitType::supplyProvided () const

Retrieves the amount of supply that this unit type produces for its appropriate Race's supply pool.

Note: 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.

See also: supplyRequired, PlayerInterface::supplyTotal, PlayerInterface::supplyUsed

int BWAPI::UnitType::spaceRequired () const

Retrieves the amount of space required by this unit type to fit inside a Bunker or Transport(Dropship, Shuttle, Overlord ).

Returns: Amount of space required by this unit type for transport.

Return values

255	If this unit type can not be transported.

See also: spaceProvided

int BWAPI::UnitType::spaceProvided () const

Retrieves the amount of space provided by this Bunker or Transport(Dropship, Shuttle, Overlord ) for unit transportation.

Returns: The number of slots provided by this unit type.

See also: spaceRequired

int BWAPI::UnitType::buildScore () const

Retrieves the amount of score points awarded for constructing this unit type.

This value is used for calculating scores in the post-game score screen.

Returns: Number of points awarded for constructing this unit type.

See also: destroyScore

int BWAPI::UnitType::destroyScore () const

Retrieves the amount of score points awarded for killing this unit type.

This value is used for calculating scores in the post-game score screen.

Returns: Number of points awarded for killing this unit type.

See also: buildScore

UnitSizeType BWAPI::UnitType::size () const

Retrieves the UnitSizeType of this unit, which is used in calculations along with weapon damage types to determine the amount of damage that will be dealt to this type.

Returns: UnitSizeType indicating the conceptual size of the unit type.

See also: WeaponType::damageType

int BWAPI::UnitType::tileWidth () const

Retrieves the width of this unit type, in tiles.

Used for determining the tile size of structures.

Returns: Width of this unit type, in tiles.

int BWAPI::UnitType::tileHeight () const

Retrieves the height of this unit type, in tiles.

Used for determining the tile size of structures.

Returns: Height of this unit type, in tiles.

TilePosition BWAPI::UnitType::tileSize () const

Retrieves the tile size of this unit type.

Used for determining the tile size of structures.

Returns: TilePosition containing the width (x) and height (y) of the unit type, in tiles.

int BWAPI::UnitType::dimensionLeft () const

Retrieves the distance from the center of the unit type to its left edge.

Returns: Distance to this unit type's left edge from its center, in pixels.

int BWAPI::UnitType::dimensionUp () const

Retrieves the distance from the center of the unit type to its top edge.

Returns: Distance to this unit type's top edge from its center, in pixels.

int BWAPI::UnitType::dimensionRight () const

Retrieves the distance from the center of the unit type to its right edge.

Returns: Distance to this unit type's right edge from its center, in pixels.

int BWAPI::UnitType::dimensionDown () const

Retrieves the distance from the center of the unit type to its bottom edge.

Returns: Distance to this unit type's bottom edge from its center, in pixels.

int BWAPI::UnitType::width () const

A macro for retrieving the width of the unit type, which is calculated using dimensionLeft + dimensionRight + 1.

Returns: Width of the unit, in pixels.

int BWAPI::UnitType::height () const

A macro for retrieving the height of the unit type, which is calculated using dimensionUp + dimensionDown + 1.

Returns: Height of the unit, in pixels.

int BWAPI::UnitType::seekRange () const

Retrieves the range at which this unit type will start targeting enemy units.

Returns: Distance at which this unit type begins to seek out enemy units, in pixels.

int BWAPI::UnitType::sightRange () const

Retrieves the sight range of this unit type.

Returns: Sight range of this unit type, measured in pixels.

WeaponType BWAPI::UnitType::groundWeapon () const

Retrieves this unit type's weapon type used when attacking targets on the ground.

Returns: WeaponType used as this unit type's ground weapon.

See also: maxGroundHits, airWeapon

int BWAPI::UnitType::maxGroundHits () const

Retrieves the maximum number of hits this unit can deal to a ground target using its ground weapon.

This value is multiplied by the ground weapon's damage to calculate the unit type's damage potential.

Returns: Maximum number of hits given to ground targets.

See also: groundWeapon, maxAirHits

WeaponType BWAPI::UnitType::airWeapon () const

Retrieves this unit type's weapon type used when attacking targets in the air.

Returns: WeaponType used as this unit type's air weapon.

See also: maxAirHits, groundWeapon

int BWAPI::UnitType::maxAirHits () const

Retrieves the maximum number of hits this unit can deal to a flying target using its air weapon.

This value is multiplied by the air weapon's damage to calculate the unit type's damage potential.

Returns: Maximum number of hits given to air targets.

See also: airWeapon, maxGroundHits

double BWAPI::UnitType::topSpeed () const

Retrieves this unit type's top movement speed with no upgrades.

Note: That some units have inconsistent movement and this value is sometimes an approximation.

Returns: The approximate top speed, in pixels per frame, as a double. For liftable Terran structures, this function returns their movement speed while lifted.

int BWAPI::UnitType::acceleration () const

Retrieves the unit's acceleration amount.

Returns: How fast the unit can accelerate to its top speed.

int BWAPI::UnitType::haltDistance () const

Retrieves the unit's halting distance.

This determines how fast a unit can stop moving.

Returns: A halting distance value.

int BWAPI::UnitType::turnRadius () const

Retrieves a unit's turning radius.

This determines how fast a unit can turn.

Returns: A turn radius value.

bool BWAPI::UnitType::canProduce () const

Determines if a unit can train other units.

For example, UnitTypes::Terran_Barracks.canProduce() will return true, while UnitTypes::Terran_Marine.canProduce() will return false. This is also true for two non-structures: Carrier (can produce interceptors) and Reaver (can produce scarabs).

Returns: true if this unit type can have a production queue, and false otherwise.

bool BWAPI::UnitType::canAttack () const

Checks if this unit is capable of attacking.

Note: This function returns false for units that can only inflict damage via special abilities, such as the High Templar.

Returns: true if this unit type is capable of damaging other units with a standard attack, and false otherwise.

bool BWAPI::UnitType::canMove () const

Checks if this unit type is capable of movement.

Note: Buildings will return false, including Terran liftable buildings which are capable of moving when lifted.

Returns: true if this unit can use a movement command, and false if they cannot move.

bool BWAPI::UnitType::isFlyer () const

Checks if this unit type is a flying unit.

Flying units ignore ground pathing and collisions.

Returns: true if this unit type is in the air by default, and false otherwise.

bool BWAPI::UnitType::regeneratesHP () const

Checks if this unit type can regenerate hit points.

This generally applies to Zerg units.

Returns: true if this unit type regenerates its hit points, and false otherwise.

bool BWAPI::UnitType::isSpellcaster () const

Checks if this unit type has the capacity to store energy and use it for special abilities.

Returns: true if this unit type generates energy, and false if it does not have an energy pool.

bool BWAPI::UnitType::hasPermanentCloak () const

Checks if this unit type is permanently cloaked.

This means the unit type is always cloaked and requires a detector in order to see it.

Returns: true if this unit type is permanently cloaked, and false otherwise.

bool BWAPI::UnitType::isInvincible () const

Checks if this unit type is invincible by default.

Invincible units cannot take damage.

Returns: true if this unit type is invincible, and false if it is vulnerable to attacks.

bool BWAPI::UnitType::isOrganic () const

Checks if this unit is an organic unit.

The organic property is required for some abilities such as Heal.

Returns: true if this unit type has the organic property, and false otherwise.

bool BWAPI::UnitType::isMechanical () const

Checks if this unit is mechanical.

The mechanical property is required for some actions such as Repair.

Returns: true if this unit type has the mechanical property, and false otherwise.

bool BWAPI::UnitType::isRobotic () const

Checks if this unit is robotic.

The robotic property is applied to robotic units such as the Probe which prevents them from taking damage from Irradiate.

Returns: true if this unit type has the robotic property, and false otherwise.

bool BWAPI::UnitType::isDetector () const

Checks if this unit type is capable of detecting units that are cloaked or burrowed.

Returns: true if this unit type is a detector by default, false if it does not have this property

bool BWAPI::UnitType::isResourceContainer () const

Checks if this unit type is capable of storing resources such as Mineral Fields.

Resources are harvested from resource containers.

Returns: true if this unit type may contain resources that can be harvested, false otherwise.

bool BWAPI::UnitType::isResourceDepot () const

Checks if this unit type is a resource depot.

Resource depots must be placed a certain distance from resources. Resource depots are typically the main building for any particular race. Workers will return resources to the nearest resource depot.

Example:

if ( BWAPI::Broodwar->self() )
{
BWAPI::Unitset myUnits = BWAPI::Broodwar->self()->getUnits();
for ( auto u : myUnits )
 {
if ( u->isIdle() && u->getType().isResourceDepot() )
 u->train( u->getType().getRace().getWorker() );
 }
}

Returns: true if the unit type is a resource depot, false if it is not.

bool BWAPI::UnitType::isRefinery () const

Checks if this unit type is a refinery.

A refinery is a structure that is placed on top of a Vespene Geyser . Refinery types are Refinery , Extractor , and Assimilator.

Example:

if ( BWAPI::Broodwar->self() )
{
BWAPI::Unitset myUnits = BWAPI::Broodwar->self()->getUnits();
for ( auto u : myUnits )
 {
if ( u->getType().isRefinery() )
 {
int nWorkersAssigned = u->getClientInfo<int>('work');
if ( nWorkersAssigned < 3 )
 {
Unit pClosestIdleWorker = u->getClosestUnit(BWAPI::Filter::IsWorker && BWAPI::Filter::IsIdle);
if ( pClosestIdleWorker )
 {
// gather from the refinery (and check if successful)
if ( pClosestIdleWorker->gather(u) )
 {
// set a back reference for when the unit is killed or re-assigned (code not provided)
 pClosestIdleWorker->setClientInfo(u, 'ref');
// Increment the number of workers assigned and associate it with the refinery
 ++nWorkersAssigned;
 u->setClientInfo(nWorkersAssigned, 'work');
 }
 }
 } // workers < 3
 } // isRefinery
 } // for
}

Returns: true if this unit type is a refinery, and false if it is not.

bool BWAPI::UnitType::isWorker () const

Checks if this unit type is a worker unit.

Worker units can harvest resources and build structures. Worker unit types include the SCV , Probe, and Drone.

Returns: true if this unit type is a worker, and false if it is not.

bool BWAPI::UnitType::requiresPsi () const

Checks if this structure is powered by a psi field.

Structures powered by psi can only be placed near a Pylon. If the Pylon is destroyed, then this unit will lose power.

Returns: true if this unit type can only be placed in a psi field, false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: isBuilding(), getRace() == Races::Protoss

bool BWAPI::UnitType::requiresCreep () const

Checks if this structure must be placed on Zerg creep.

Returns: true if this unit type requires creep, false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: isBuilding(), getRace() == Races::Zerg

bool BWAPI::UnitType::isTwoUnitsInOneEgg () const

Checks if this unit type spawns two units when being hatched from an Egg.

This is only applicable to Zerglings and Scourges.

Returns: true if morphing this unit type will spawn two of them, and false if only one is spawned.

bool BWAPI::UnitType::isBurrowable () const

Checks if this unit type has the capability to use the Burrow technology when it is researched.

Note: The Lurker can burrow even without researching the ability.

See also: TechTypes::Burrow

Returns: true if this unit can use the Burrow ability, and false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: getRace() == Races::Zerg, !isBuilding(), canMove()

bool BWAPI::UnitType::isCloakable () const

Checks if this unit type has the capability to use a cloaking ability when it is researched.

This applies only to Wraiths and Ghosts, and does not include units which are permanently cloaked.

Returns: true if this unit has a cloaking ability, false otherwise.

See also: hasPermanentCloak, TechTypes::Cloaking_Field, TechTypes::Personnel_Cloaking

bool BWAPI::UnitType::isBuilding () const

Checks if this unit is a structure.

This includes Mineral Fields and Vespene Geysers.

Returns: true if this unit is a building, and false otherwise.

bool BWAPI::UnitType::isAddon () const

Checks if this unit is an add-on.

Add-ons are attachments used by some Terran structures such as the Comsat Station.

Returns: true if this unit is an add-on, and false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: getRace() == Races::Terran, isBuilding()

bool BWAPI::UnitType::isFlyingBuilding () const

Checks if this structure has the capability to use the lift-off command.

Returns: true if this unit type is a flyable building, false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: isBuilding()

bool BWAPI::UnitType::isNeutral () const

Checks if this unit type is a neutral type, such as critters and resources.

Returns: true if this unit is intended to be neutral, and false otherwise.

bool BWAPI::UnitType::isHero () const

Checks if this unit type is a hero.

Heroes are types that the player cannot obtain normally, and are identified by the white border around their icon when selected with a group.

Note: There are two non-hero units included in this set, the Civilian and Dark Templar Hero.

Returns: true if this unit type is a hero type, and false otherwise.

bool BWAPI::UnitType::isPowerup () const

Checks if this unit type is a powerup.

Powerups can be picked up and carried by workers. They are usually only seen in campaign maps and Capture the Flag.

Returns: true if this unit type is a powerup type, and false otherwise.

bool BWAPI::UnitType::isBeacon () const

Checks if this unit type is a beacon.

Each race has exactly one beacon each. They are UnitTypes::Special_Zerg_Beacon, UnitTypes::Special_Terran_Beacon, and UnitTypes::Special_Protoss_Beacon.

See also: isFlagBeacon

Returns: true if this unit type is one of the three race beacons, and false otherwise.

bool BWAPI::UnitType::isFlagBeacon () const

Checks if this unit type is a flag beacon.

Each race has exactly one flag beacon each. They are UnitTypes::Special_Zerg_Flag_Beacon, UnitTypes::Special_Terran_Flag_Beacon, and UnitTypes::Special_Protoss_Flag_Beacon. Flag beacons spawn a Flag after some ARBITRARY I FORGOT AMOUNT OF FRAMES.

See also: isBeacon

Returns: true if this unit type is one of the three race flag beacons, and false otherwise.

bool BWAPI::UnitType::isSpecialBuilding () const

Checks if this structure is special and cannot be obtained normally within the game.

Returns: true if this structure is a special building, and false otherwise.

Note: If this function returns a successful state, then the following function calls will also return a successful state: isBuilding()

bool BWAPI::UnitType::isSpell () const

Identifies if this unit type is used to complement some abilities.

These include UnitTypes::Spell_Dark_Swarm, UnitTypes::Spell_Disruption_Web, and UnitTypes::Spell_Scanner_Sweep, which correspond to TechTypes::Dark_Swarm, TechTypes::Disruption_Web, and TechTypes::Scanner_Sweep respectively.

Returns: true if this unit type is used for an ability, and false otherwise.

bool BWAPI::UnitType::producesCreep () const

Checks if this structure type produces creep.

That is, the unit type spreads creep over a wide area so that Zerg structures can be placed on it.

Returns: true if this unit type spreads creep.

Note: If this function returns a successful state, then the following function calls will also return a successful state: getRace() == Races::Zerg, isBuilding()

Since: 4.1.2

bool BWAPI::UnitType::producesLarva () const

Checks if this unit type produces larva.

This is essentially used to check if the unit type is a Hatchery, Lair, or Hive.

Returns: true if this unit type produces larva.

Note: If this function returns a successful state, then the following function calls will also return a successful state: getRace() == Races::Zerg, isBuilding()

bool BWAPI::UnitType::isMineralField () const

Checks if this unit type is a mineral field and contains a resource amount.

This indicates that the unit type is either UnitTypes::Resource_Mineral_Field, UnitTypes::Resource_Mineral_Field_Type_2, or UnitTypes::Resource_Mineral_Field_Type_3.

Returns: true if this unit type is a mineral field resource.

bool BWAPI::UnitType::isCritter () const

Checks if this unit type is a neutral critter.

Returns: true if this unit type is a critter, and false otherwise.

Example usage:

BWAPI::Position myBasePosition( BWAPI::Broodwar->self()->getStartLocation() );
BWAPI::UnitSet unitsAroundTheBase = BWAPI::Broodwar->getUnitsInRadius(myBasePosition, 1024, !BWAPI::Filter::IsOwned && !BWAPI::Filter::IsParasited);
for ( auto u : unitsAroundTheBase )
{
if ( u->getType().isCritter() && !u->isInvincible() )
 {
BWAPI::Unit myQueen = u->getClosestUnit(BWAPI::Filter::GetType == BWAPI::UnitTypes::Zerg_Queen && BWAPI::Filter::IsOwned);
if ( myQueen )
 myQueen->useTech(BWAPI::TechTypes::Parasite, u);
 }
}

bool BWAPI::UnitType::canBuildAddon () const

Checks if this unit type is capable of constructing an add-on.

An add-on is an extension or attachment for Terran structures, specifically the Command Center, Factory, Starport, and Science Facility.

Returns: true if this unit type can construct an add-on, and false if it can not.

See also: isAddon

const UnitType::set& BWAPI::UnitType::buildsWhat () const

Retrieves the set of units that this unit type is capable of creating.

This includes training, constructing, warping, and morphing.

Note: Some maps have special parameters that disable construction of units that are otherwise normally available. Use PlayerInterface::isUnitAvailable to determine if a unit type is actually available in the current game for a specific player.

Returns: UnitType::set containing the units it can build.

See also: PlayerInterface::isUnitAvailable

Since: 4.1.2

const SetContainer<TechType>& BWAPI::UnitType::researchesWhat () const

Retrieves the set of technologies that this unit type is capable of researching.

Note: Some maps have special parameters that disable certain technologies. Use PlayerInterface::isResearchAvailable to determine if a technology is actually available in the current game for a specific player.

Returns: TechType::set containing the technology types that can be researched.

See also: PlayerInterface::isResearchAvailable

Since: 4.1.2

const SetContainer<UpgradeType>& BWAPI::UnitType::upgradesWhat () const

Retrieves the set of upgrades that this unit type is capable of upgrading.

Note: Some maps have special upgrade limitations. Use PlayerInterface::getMaxUpgradeLevel to check if an upgrade is available.

Returns: UpgradeType::set containing the upgrade types that can be upgraded.

See also: PlayerInterface::getMaxUpgradeLevel

Since: 4.1.2

bool BWAPI::UnitType::isSuccessorOf (UnitType type) const

Checks if the current type is equal to the provided type, or a successor of the provided type.

For example, a Hive is a successor of a Hatchery, since it can still research the Burrow technology.

Parameters

type	The unit type to check.

See also: TechType::whatResearches, UpgradeType::whatUpgrades

Since: 4.2.0

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation