BWAPI::WeaponType Class Reference

#include <WeaponType.h>

Inheritance diagram for BWAPI::WeaponType:

Collaboration diagram for BWAPI::WeaponType:

List of all members.

Public Member Functions
	WeaponType ()
	WeaponType (int id)
const std::string &	getName () const
const char *	c_str () 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

)

---

Member Function Documentation

const char * BWAPI::WeaponType::c_str

(

)

const

Here is the call graph for this function:

int BWAPI::WeaponType::damageAmount

(

)

const

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

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::damageBonus

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::damageCooldown

(

)

const

Returns the amount of cooldown time between attacks.

Here is the call graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

DamageType BWAPI::WeaponType::damageType

(

)

const

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

Here is the call graph for this function:

Here is the caller graph for this function:

ExplosionType BWAPI::WeaponType::explosionType

(

)

const

Returns the type of explosion that this weapon uses.

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string & BWAPI::WeaponType::getName

(

)

const

Returns the name of the weapon.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::innerSplashRadius

(

)

const

Inner radius used in splash damage calculations.

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::maxRange

(

)

const

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

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::medianSplashRadius

(

)

const

Median radius used in splash damage calculations.

Here is the call graph for this function:

Here is the caller graph for this function:

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).

Here is the call graph for this function:

Here is the caller graph for this function:

int BWAPI::WeaponType::outerSplashRadius

(

)

const

Outer radius used in splash damage calculations.

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsAir

(

)

const

Returns true if this weapon can attack air units.

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsGround

(

)

const

Returns true if this weapon can attack ground units.

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsMechanical

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsNonBuilding

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsNonRobotic

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsOrganic

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsOrgOrMech

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsOwn

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

bool BWAPI::WeaponType::targetsTerrain

(

)

const

Here is the call graph for this function:

Here is the caller graph for this function:

UpgradeType BWAPI::WeaponType::upgradeType

(

)

const

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

Here is the call graph for this function:

Here is the caller graph for this function:

UnitType BWAPI::WeaponType::whatUses

(

)

const

Returns the unit that can use this weapon.

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/WeaponType.h
• trunk/bwapi/BWAPILIB/Source/WeaponType.cpp