BWAPI::WeaponType Class Reference

#include <WeaponType.h>

List of all members.

Public Member Functions
	WeaponType ()
	WeaponType (int id)
	WeaponType (const WeaponType &other)
WeaponType &	operator= (const WeaponType &other)
	operator int () const
int	getID () const
std::string	getName () const
TechType	getTech () const
UnitType	whatUses () const
int	damageAmount () const
int	damageBonus () const
int	damageCooldown () const
int	damageFactor () const
UpgradeType	upgradeType () const
DamageType	damageType () const
ExplosionType	explosionType () const
int	minRange () const
int	maxRange () const
int	innerSplashRadius () const
int	medianSplashRadius () const
int	outerSplashRadius () const
bool	targetsAir () const
bool	targetsGround () const
bool	targetsMechanical () const
bool	targetsOrganic () const
bool	targetsNonBuilding () const
bool	targetsNonRobotic () const
bool	targetsTerrain () const
bool	targetsOrgOrMech () const
bool	targetsOwn () const

---

Constructor & Destructor Documentation

BWAPI::WeaponType::WeaponType

(

)

BWAPI::WeaponType::WeaponType

(

int

id

)

BWAPI::WeaponType::WeaponType

(

const WeaponType &

other

)

---

Member Function Documentation

int BWAPI::WeaponType::damageAmount

(

)

const

Returns the amount of damage that this weapon deals per attack.

Here is the caller graph for this function:

int BWAPI::WeaponType::damageBonus

(

)

const

int BWAPI::WeaponType::damageCooldown

(

)

const

Returns the amount of cooldown time between attacks.

Here is the caller graph for this function:

int BWAPI::WeaponType::damageFactor

(

)

const

Returns the amount that the damage increases per upgrade.

See also:

WeaponType::upgradeType.

DamageType BWAPI::WeaponType::damageType

(

)

const

Returns the type of damage that this weapon uses (i.e. concussive, normal, explosive, etc).

ExplosionType BWAPI::WeaponType::explosionType

(

)

const

Returns the type of explosion that this weapon uses.

int BWAPI::WeaponType::getID

(

)

const

Returns a unique ID for this weapon type.

std::string BWAPI::WeaponType::getName

(

)

const

Returns the name of the weapon.

TechType BWAPI::WeaponType::getTech

(

)

const

Returns the tech type that must be researched before this weapon can be used, or TechTypes::None if no tech type is required.

int BWAPI::WeaponType::innerSplashRadius

(

)

const

Inner radius used in splash damage calculations.

int BWAPI::WeaponType::maxRange

(

)

const

Returns the maximum attack range of the weapon, measured in pixels.

int BWAPI::WeaponType::medianSplashRadius

(

)

const

Median radius used in splash damage calculations.

int BWAPI::WeaponType::minRange

(

)

const

Returns the minimum attack range of the weapon, measured in pixels, 0 for most things except WeaponTypes::Arclite_Shock_Cannon (the weapon of the Terran Siege Tank in Siege Mode).

BWAPI::WeaponType::operator int

(

)

const

WeaponType& BWAPI::WeaponType::operator=

(

const WeaponType &

other

)

int BWAPI::WeaponType::outerSplashRadius

(

)

const

Outer radius used in splash damage calculations.

bool BWAPI::WeaponType::targetsAir

(

)

const

Returns true if this weapon can attack air units.

bool BWAPI::WeaponType::targetsGround

(

)

const

Returns true if this weapon can attack ground units.

bool BWAPI::WeaponType::targetsMechanical

(

)

const

bool BWAPI::WeaponType::targetsNonBuilding

(

)

const

bool BWAPI::WeaponType::targetsNonRobotic

(

)

const

bool BWAPI::WeaponType::targetsOrganic

(

)

const

bool BWAPI::WeaponType::targetsOrgOrMech

(

)

const

bool BWAPI::WeaponType::targetsOwn

(

)

const

bool BWAPI::WeaponType::targetsTerrain

(

)

const

UpgradeType BWAPI::WeaponType::upgradeType

(

)

const

Returns the upgrade type that can be upgraded to increase the attack damage.

UnitType BWAPI::WeaponType::whatUses

(

)

const

Returns the unit that can use this weapon.

---

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

• Aiur/include/BWAPI/WeaponType.h