BWAPI  4.1.2
An API for interacting with Starcraft: Broodwar (1.16.1)
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules
Variables
BWAPI::Filter Namespace Reference

Variables

const PtrIntCompareUnitFilter AcidSporeCount
 
const CompareFilter< Unit,WeaponType,
WeaponType(*)(Unit)> 
AirWeapon
 
const PtrIntCompareUnitFilter Armor
 
const CompareFilter< Unit,UpgradeType,
UpgradeType(*)(Unit)> 
ArmorUpgrade
 
const PtrIntCompareUnitFilter BuildScore
 
const PtrIntCompareUnitFilter BuildTime
 
const CompareFilter< Unit,UnitType,
UnitType(*)(Unit)> 
BuildType
 
const PtrUnitFilter CanAttack
 
const PtrUnitFilter CanBuildAddon
 
const PtrUnitFilter CanMove
 
const PtrUnitFilter CanProduce
 
const CompareFilter< Unit,Order,
Order(*)(Unit)> 
CurrentOrder
 
const PtrIntCompareUnitFilter DefenseMatrixPoints
 
const PtrIntCompareUnitFilter DefenseMatrixTime
 
const PtrIntCompareUnitFilter DestroyScore
 
const PtrIntCompareUnitFilter Energy
 
const PtrIntCompareUnitFilter Energy_Percent
 
const PtrIntCompareUnitFilter EnsnareTime
 
const PtrUnitFilter Exists
 
const PtrIntCompareUnitFilter GasPrice
 
const PtrIntCompareUnitFilter GetBottom
 
const PtrIntCompareUnitFilter GetLeft
 
const CompareFilter< Unit,Player,
Player(*)(Unit)> 
GetPlayer
 
const CompareFilter< Unit,Race,
Race(*)(Unit)> 
GetRace
 
const PtrIntCompareUnitFilter GetRight
 
const PtrIntCompareUnitFilter GetTop
 
const CompareFilter< Unit,UnitType,
UnitType(*)(Unit)> 
GetType
 
const CompareFilter< Unit,WeaponType,
WeaponType(*)(Unit)> 
GroundWeapon
 
const PtrUnitFilter HasPermanentCloak
 
const PtrIntCompareUnitFilter HP
 
const PtrIntCompareUnitFilter HP_Percent
 
const PtrIntCompareUnitFilter InterceptorCount
 
const PtrIntCompareUnitFilter IrradiateTime
 
const PtrUnitFilter IsAddon
 
const PtrUnitFilter IsAlly
 
const PtrUnitFilter IsAttacking
 
const PtrUnitFilter IsBeacon
 
const PtrUnitFilter IsBeingConstructed
 
const PtrUnitFilter IsBeingGathered
 
const PtrUnitFilter IsBeingHealed
 
const PtrUnitFilter IsBlind
 
const PtrUnitFilter IsBraking
 
const PtrUnitFilter IsBuilding
 
const PtrUnitFilter IsBurrowable
 
const PtrUnitFilter IsBurrowed
 
const PtrUnitFilter IsCarryingGas
 
const PtrUnitFilter IsCarryingMinerals
 
const PtrUnitFilter IsCarryingSomething
 
const PtrUnitFilter IsCloakable
 
const PtrUnitFilter IsCloaked
 
const PtrUnitFilter IsCompleted
 
const PtrUnitFilter IsConstructing
 
const PtrUnitFilter IsCritter
 
const PtrUnitFilter IsDefenseMatrixed
 
const PtrUnitFilter IsDetected
 
const PtrUnitFilter IsDetector
 
const PtrUnitFilter IsEnemy
 
const PtrUnitFilter IsEnsnared
 
const PtrUnitFilter IsFlagBeacon
 
const PtrUnitFilter IsFlyer
 
const PtrUnitFilter IsFlying
 
const PtrUnitFilter IsFlyingBuilding
 
const PtrUnitFilter IsFollowing
 
const PtrUnitFilter IsGatheringGas
 
const PtrUnitFilter IsGatheringMinerals
 
const PtrUnitFilter IsHallucination
 
const PtrUnitFilter IsHero
 
const PtrUnitFilter IsHoldingPosition
 
const PtrUnitFilter IsIdle
 
const PtrUnitFilter IsInterruptible
 
const PtrUnitFilter IsInvincible
 
const PtrUnitFilter IsIrradiated
 
const PtrUnitFilter IsLifted
 
const PtrUnitFilter IsLoaded
 
const PtrUnitFilter IsLockedDown
 
const PtrUnitFilter IsMaelstrommed
 
const PtrUnitFilter IsMechanical
 
const PtrUnitFilter IsMineralField
 
const PtrUnitFilter IsMorphing
 
const PtrUnitFilter IsMoving
 
const PtrUnitFilter IsNeutral
 
const PtrUnitFilter IsOrganic
 
const PtrUnitFilter IsOwned
 
const PtrUnitFilter IsParasited
 
const PtrUnitFilter IsPatrolling
 
const PtrUnitFilter IsPlagued
 
const PtrUnitFilter IsPowered
 
const PtrUnitFilter IsPowerup
 
const PtrUnitFilter IsRefinery
 
const PtrUnitFilter IsRepairing
 
const PtrUnitFilter IsResearching
 
const PtrUnitFilter IsResourceContainer
 
const PtrUnitFilter IsResourceDepot
 
const PtrUnitFilter IsRobotic
 
const PtrUnitFilter IsSieged
 
const PtrUnitFilter IsSpecialBuilding
 
const PtrUnitFilter IsSpell
 
const PtrUnitFilter IsSpellcaster
 
const PtrUnitFilter IsStartingAttack
 
const PtrUnitFilter IsStasised
 
const PtrUnitFilter IsStimmed
 
const PtrUnitFilter IsStuck
 
const PtrUnitFilter IsTraining
 
const PtrUnitFilter IsTransport
 
const PtrUnitFilter IsUnderAttack
 
const PtrUnitFilter IsUnderDarkSwarm
 
const PtrUnitFilter IsUnderDisruptionWeb
 
const PtrUnitFilter IsUnderStorm
 
const PtrUnitFilter IsVisible
 
const PtrUnitFilter IsWorker
 
const PtrIntCompareUnitFilter LockdownTime
 
const PtrIntCompareUnitFilter MaelstromTime
 
const PtrIntCompareUnitFilter MaxEnergy
 
const PtrIntCompareUnitFilter MaxHP
 
const PtrIntCompareUnitFilter MaxShields
 
const PtrIntCompareUnitFilter MaxWeaponCooldown
 
const PtrIntCompareUnitFilter MineralPrice
 
const CompareFilter< Unit,Unit,Unit(*)(Unit)> OrderTarget
 
const PtrIntCompareUnitFilter OrderTime
 
const PtrIntCompareUnitFilter PlagueTimer
 
const PtrUnitFilter ProducesLarva
 
const PtrUnitFilter RegeneratesHP
 
const PtrIntCompareUnitFilter RemainingBuildTime
 
const PtrIntCompareUnitFilter RemainingTrainTime
 
const PtrIntCompareUnitFilter RemoveTime
 
const PtrUnitFilter RequiresCreep
 
const PtrUnitFilter RequiresPsi
 
const PtrIntCompareUnitFilter ResourceGroup
 
const PtrIntCompareUnitFilter Resources
 
const PtrIntCompareUnitFilter ScarabCount
 
const CompareFilter< Unit,Order,
Order(*)(Unit)> 
SecondaryOrder
 
const PtrIntCompareUnitFilter Shields
 
const PtrIntCompareUnitFilter Shields_Percent
 
const PtrIntCompareUnitFilter SightRange
 
const CompareFilter< Unit,UnitSizeType,
UnitSizeType(*)(Unit)> 
SizeType
 
const PtrIntCompareUnitFilter SpaceProvided
 
const PtrIntCompareUnitFilter SpaceRemaining
 
const PtrIntCompareUnitFilter SpaceRequired
 
const PtrIntCompareUnitFilter SpellCooldown
 
const PtrIntCompareUnitFilter SpiderMineCount
 
const PtrIntCompareUnitFilter StasisTime
 
const PtrIntCompareUnitFilter StimTime
 
const PtrIntCompareUnitFilter SupplyProvided
 
const PtrIntCompareUnitFilter SupplyRequired
 
const CompareFilter< Unit,Unit,Unit(*)(Unit)> Target
 
const CompareFilter< Unit,double,
double(*)(Unit)> 
TopSpeed
 
const PtrIntCompareUnitFilter WeaponCooldown
 

Variable Documentation

const PtrUnitFilter BWAPI::Filter::IsTransport

A unary filter that checks if the unit type is a transport.

const PtrUnitFilter BWAPI::Filter::CanProduce
const PtrUnitFilter BWAPI::Filter::CanAttack
const PtrUnitFilter BWAPI::Filter::CanMove
const PtrUnitFilter BWAPI::Filter::IsFlyer
See also
BWAPI::UnitType::isFlying
const PtrUnitFilter BWAPI::Filter::IsFlying
See also
BWAPI::UnitInterface::IsFlying
const PtrUnitFilter BWAPI::Filter::RegeneratesHP
const PtrUnitFilter BWAPI::Filter::IsSpellcaster
const PtrUnitFilter BWAPI::Filter::HasPermanentCloak
const PtrUnitFilter BWAPI::Filter::IsOrganic
const PtrUnitFilter BWAPI::Filter::IsMechanical
const PtrUnitFilter BWAPI::Filter::IsRobotic
const PtrUnitFilter BWAPI::Filter::IsDetector
const PtrUnitFilter BWAPI::Filter::IsResourceContainer
const PtrUnitFilter BWAPI::Filter::IsResourceDepot
const PtrUnitFilter BWAPI::Filter::IsRefinery
const PtrUnitFilter BWAPI::Filter::IsWorker
const PtrUnitFilter BWAPI::Filter::RequiresPsi
const PtrUnitFilter BWAPI::Filter::RequiresCreep
const PtrUnitFilter BWAPI::Filter::IsBurrowable
const PtrUnitFilter BWAPI::Filter::IsCloakable
const PtrUnitFilter BWAPI::Filter::IsBuilding
const PtrUnitFilter BWAPI::Filter::IsAddon
const PtrUnitFilter BWAPI::Filter::IsFlyingBuilding
const PtrUnitFilter BWAPI::Filter::IsNeutral
const PtrUnitFilter BWAPI::Filter::IsHero
const PtrUnitFilter BWAPI::Filter::IsPowerup
const PtrUnitFilter BWAPI::Filter::IsBeacon
const PtrUnitFilter BWAPI::Filter::IsFlagBeacon
const PtrUnitFilter BWAPI::Filter::IsSpecialBuilding
const PtrUnitFilter BWAPI::Filter::IsSpell
const PtrUnitFilter BWAPI::Filter::ProducesLarva
const PtrUnitFilter BWAPI::Filter::IsMineralField
const PtrUnitFilter BWAPI::Filter::IsCritter
const PtrUnitFilter BWAPI::Filter::CanBuildAddon
const PtrIntCompareUnitFilter BWAPI::Filter::HP
const PtrIntCompareUnitFilter BWAPI::Filter::MaxHP
const PtrIntCompareUnitFilter BWAPI::Filter::HP_Percent

A comparison filter that retrieves the unit's HP percentage.

The formula is HP*100/MaxHP.

const PtrIntCompareUnitFilter BWAPI::Filter::Shields
const PtrIntCompareUnitFilter BWAPI::Filter::MaxShields
const PtrIntCompareUnitFilter BWAPI::Filter::Shields_Percent

A comparison filter that retrieves the unit's shields percentage.

The formula is Shields*100/MaxShields.

const PtrIntCompareUnitFilter BWAPI::Filter::Energy
const PtrIntCompareUnitFilter BWAPI::Filter::MaxEnergy
const PtrIntCompareUnitFilter BWAPI::Filter::Energy_Percent

A comparison filter that retrieves the unit's energy percentage.

The formula is Energy*100/MaxEnergy.

const PtrIntCompareUnitFilter BWAPI::Filter::Armor
const CompareFilter<Unit ,UpgradeType,UpgradeType (*)(Unit )> BWAPI::Filter::ArmorUpgrade
const PtrIntCompareUnitFilter BWAPI::Filter::MineralPrice
const PtrIntCompareUnitFilter BWAPI::Filter::GasPrice
const PtrIntCompareUnitFilter BWAPI::Filter::BuildTime
const PtrIntCompareUnitFilter BWAPI::Filter::SupplyRequired
const PtrIntCompareUnitFilter BWAPI::Filter::SupplyProvided
const PtrIntCompareUnitFilter BWAPI::Filter::SpaceRequired
const PtrIntCompareUnitFilter BWAPI::Filter::SpaceRemaining
const PtrIntCompareUnitFilter BWAPI::Filter::SpaceProvided
const PtrIntCompareUnitFilter BWAPI::Filter::BuildScore
const PtrIntCompareUnitFilter BWAPI::Filter::DestroyScore
const CompareFilter<Unit ,double,double (*)(Unit )> BWAPI::Filter::TopSpeed
const PtrIntCompareUnitFilter BWAPI::Filter::SightRange
const PtrIntCompareUnitFilter BWAPI::Filter::WeaponCooldown
const CompareFilter<Unit ,UnitSizeType,UnitSizeType (*)(Unit )> BWAPI::Filter::SizeType
const CompareFilter<Unit ,WeaponType,WeaponType (*)(Unit )> BWAPI::Filter::GroundWeapon
const CompareFilter<Unit ,WeaponType,WeaponType (*)(Unit )> BWAPI::Filter::AirWeapon
const CompareFilter<Unit ,UnitType,UnitType (*)(Unit )> BWAPI::Filter::GetType
const CompareFilter<Unit ,Race,Race (*)(Unit )> BWAPI::Filter::GetRace
const CompareFilter<Unit ,Player,Player (*)(Unit )> BWAPI::Filter::GetPlayer
const PtrIntCompareUnitFilter BWAPI::Filter::Resources
const PtrIntCompareUnitFilter BWAPI::Filter::ResourceGroup
const PtrIntCompareUnitFilter BWAPI::Filter::AcidSporeCount
const PtrIntCompareUnitFilter BWAPI::Filter::InterceptorCount
const PtrIntCompareUnitFilter BWAPI::Filter::ScarabCount
const PtrIntCompareUnitFilter BWAPI::Filter::SpiderMineCount
const PtrIntCompareUnitFilter BWAPI::Filter::MaxWeaponCooldown
const PtrIntCompareUnitFilter BWAPI::Filter::SpellCooldown
const PtrIntCompareUnitFilter BWAPI::Filter::DefenseMatrixPoints
const PtrIntCompareUnitFilter BWAPI::Filter::DefenseMatrixTime
const PtrIntCompareUnitFilter BWAPI::Filter::EnsnareTime
const PtrIntCompareUnitFilter BWAPI::Filter::IrradiateTime
const PtrIntCompareUnitFilter BWAPI::Filter::LockdownTime
const PtrIntCompareUnitFilter BWAPI::Filter::MaelstromTime
const PtrIntCompareUnitFilter BWAPI::Filter::OrderTime
const PtrIntCompareUnitFilter BWAPI::Filter::PlagueTimer
const PtrIntCompareUnitFilter BWAPI::Filter::RemoveTime
const PtrIntCompareUnitFilter BWAPI::Filter::StasisTime
const PtrIntCompareUnitFilter BWAPI::Filter::StimTime
const CompareFilter<Unit ,UnitType,UnitType (*)(Unit )> BWAPI::Filter::BuildType
const PtrIntCompareUnitFilter BWAPI::Filter::RemainingBuildTime
const PtrIntCompareUnitFilter BWAPI::Filter::RemainingTrainTime
const CompareFilter<Unit ,Unit ,Unit (*)(Unit )> BWAPI::Filter::Target
const CompareFilter<Unit ,Order,Order (*)(Unit )> BWAPI::Filter::CurrentOrder
const CompareFilter<Unit ,Order,Order (*)(Unit )> BWAPI::Filter::SecondaryOrder
const CompareFilter<Unit ,Unit ,Unit (*)(Unit )> BWAPI::Filter::OrderTarget
const PtrIntCompareUnitFilter BWAPI::Filter::GetLeft
const PtrIntCompareUnitFilter BWAPI::Filter::GetTop
const PtrIntCompareUnitFilter BWAPI::Filter::GetRight
const PtrIntCompareUnitFilter BWAPI::Filter::GetBottom
const PtrUnitFilter BWAPI::Filter::Exists
const PtrUnitFilter BWAPI::Filter::IsAttacking
const PtrUnitFilter BWAPI::Filter::IsBeingConstructed
const PtrUnitFilter BWAPI::Filter::IsBeingGathered
const PtrUnitFilter BWAPI::Filter::IsBeingHealed
const PtrUnitFilter BWAPI::Filter::IsBlind
const PtrUnitFilter BWAPI::Filter::IsBraking
const PtrUnitFilter BWAPI::Filter::IsBurrowed
const PtrUnitFilter BWAPI::Filter::IsCarryingGas
const PtrUnitFilter BWAPI::Filter::IsCarryingMinerals
const PtrUnitFilter BWAPI::Filter::IsCarryingSomething

A unary filter that checks if IsCarryingGas or IsCarryingMinerals return true.

const PtrUnitFilter BWAPI::Filter::IsCloaked
const PtrUnitFilter BWAPI::Filter::IsCompleted
const PtrUnitFilter BWAPI::Filter::IsConstructing
const PtrUnitFilter BWAPI::Filter::IsDefenseMatrixed
const PtrUnitFilter BWAPI::Filter::IsDetected
const PtrUnitFilter BWAPI::Filter::IsEnsnared
const PtrUnitFilter BWAPI::Filter::IsFollowing
const PtrUnitFilter BWAPI::Filter::IsGatheringGas
const PtrUnitFilter BWAPI::Filter::IsGatheringMinerals
const PtrUnitFilter BWAPI::Filter::IsHallucination
const PtrUnitFilter BWAPI::Filter::IsHoldingPosition
const PtrUnitFilter BWAPI::Filter::IsIdle
const PtrUnitFilter BWAPI::Filter::IsInterruptible
const PtrUnitFilter BWAPI::Filter::IsInvincible
const PtrUnitFilter BWAPI::Filter::IsIrradiated
const PtrUnitFilter BWAPI::Filter::IsLifted
const PtrUnitFilter BWAPI::Filter::IsLoaded
const PtrUnitFilter BWAPI::Filter::IsLockedDown
const PtrUnitFilter BWAPI::Filter::IsMaelstrommed
const PtrUnitFilter BWAPI::Filter::IsMorphing
const PtrUnitFilter BWAPI::Filter::IsMoving
const PtrUnitFilter BWAPI::Filter::IsParasited
const PtrUnitFilter BWAPI::Filter::IsPatrolling
const PtrUnitFilter BWAPI::Filter::IsPlagued
const PtrUnitFilter BWAPI::Filter::IsRepairing
const PtrUnitFilter BWAPI::Filter::IsResearching
const PtrUnitFilter BWAPI::Filter::IsSieged
const PtrUnitFilter BWAPI::Filter::IsStartingAttack
const PtrUnitFilter BWAPI::Filter::IsStasised
const PtrUnitFilter BWAPI::Filter::IsStimmed
const PtrUnitFilter BWAPI::Filter::IsStuck
const PtrUnitFilter BWAPI::Filter::IsTraining
const PtrUnitFilter BWAPI::Filter::IsUnderAttack
const PtrUnitFilter BWAPI::Filter::IsUnderDarkSwarm
const PtrUnitFilter BWAPI::Filter::IsUnderDisruptionWeb
const PtrUnitFilter BWAPI::Filter::IsUnderStorm
const PtrUnitFilter BWAPI::Filter::IsPowered
const PtrUnitFilter BWAPI::Filter::IsVisible
const PtrUnitFilter BWAPI::Filter::IsEnemy

A unary filter that checks if the current unit is an enemy of the BWAPI player.

Note
This will always be false when the BWAPI Player is unspecified, such as in a replay.
const PtrUnitFilter BWAPI::Filter::IsAlly

A unary filter that checks if the current unit is an ally of the BWAPI player.

Note
This will always be false when the BWAPI Player is unspecified, such as in a replay.
const PtrUnitFilter BWAPI::Filter::IsOwned

A unary filter that checks if the current unit is owned by the BWAPI player.

Note
This will always be false when the BWAPI Player is unspecified, such as in a replay.