BWAPI  4.2.0
An API for interacting with Starcraft: Broodwar (1.16.1)
Enumerations
BWAPI::Orders::Enum Namespace Reference

Enumerations

enum  Enum {
  Die,
  Stop,
  Guard,
  PlayerGuard,
  TurretGuard,
  BunkerGuard,
  Move,
  ReaverStop,
  Attack1,
  Attack2,
  AttackUnit,
  AttackFixedRange,
  AttackTile,
  Hover,
  AttackMove,
  InfestedCommandCenter,
  UnusedNothing,
  UnusedPowerup,
  TowerGuard,
  TowerAttack,
  VultureMine,
  StayInRange,
  TurretAttack,
  Nothing,
  Unused_24,
  DroneStartBuild,
  DroneBuild,
  CastInfestation,
  MoveToInfest,
  InfestingCommandCenter,
  PlaceBuilding,
  PlaceProtossBuilding,
  CreateProtossBuilding,
  ConstructingBuilding,
  Repair,
  MoveToRepair,
  PlaceAddon,
  BuildAddon,
  Train,
  RallyPointUnit,
  RallyPointTile,
  ZergBirth,
  ZergUnitMorph,
  ZergBuildingMorph,
  IncompleteBuilding,
  IncompleteMorphing,
  BuildNydusExit,
  EnterNydusCanal,
  IncompleteWarping,
  Follow,
  Carrier,
  ReaverCarrierMove,
  CarrierStop,
  CarrierAttack,
  CarrierMoveToAttack,
  CarrierIgnore2,
  CarrierFight,
  CarrierHoldPosition,
  Reaver,
  ReaverAttack,
  ReaverMoveToAttack,
  ReaverFight,
  ReaverHoldPosition,
  TrainFighter,
  InterceptorAttack,
  ScarabAttack,
  RechargeShieldsUnit,
  RechargeShieldsBattery,
  ShieldBattery,
  InterceptorReturn,
  DroneLand,
  BuildingLand,
  BuildingLiftOff,
  DroneLiftOff,
  LiftingOff,
  ResearchTech,
  Upgrade,
  Larva,
  SpawningLarva,
  Harvest1,
  Harvest2,
  MoveToGas,
  WaitForGas,
  HarvestGas,
  ReturnGas,
  MoveToMinerals,
  WaitForMinerals,
  MiningMinerals,
  Harvest3,
  Harvest4,
  ReturnMinerals,
  Interrupted,
  EnterTransport,
  PickupIdle,
  PickupTransport,
  PickupBunker,
  Pickup4,
  PowerupIdle,
  Sieging,
  Unsieging,
  WatchTarget,
  InitCreepGrowth,
  SpreadCreep,
  StoppingCreepGrowth,
  GuardianAspect,
  ArchonWarp,
  CompletingArchonSummon,
  HoldPosition,
  QueenHoldPosition,
  Cloak,
  Decloak,
  Unload,
  MoveUnload,
  FireYamatoGun,
  MoveToFireYamatoGun,
  CastLockdown,
  Burrowing,
  Burrowed,
  Unburrowing,
  CastDarkSwarm,
  CastParasite,
  CastSpawnBroodlings,
  CastEMPShockwave,
  NukeWait,
  NukeTrain,
  NukeLaunch,
  NukePaint,
  NukeUnit,
  CastNuclearStrike,
  NukeTrack,
  InitializeArbiter,
  CloakNearbyUnits,
  PlaceMine,
  RightClickAction,
  SuicideUnit,
  SuicideLocation,
  SuicideHoldPosition,
  CastRecall,
  Teleport,
  CastScannerSweep,
  Scanner,
  CastDefensiveMatrix,
  CastPsionicStorm,
  CastIrradiate,
  CastPlague,
  CastConsume,
  CastEnsnare,
  CastStasisField,
  CastHallucination,
  Hallucination2,
  ResetCollision,
  ResetHarvestCollision,
  Patrol,
  CTFCOPInit,
  CTFCOPStarted,
  CTFCOP2,
  ComputerAI,
  AtkMoveEP,
  HarassMove,
  AIPatrol,
  GuardPost,
  RescuePassive,
  Neutral,
  ComputerReturn,
  InitializePsiProvider,
  SelfDestructing,
  Critter,
  HiddenGun,
  OpenDoor,
  CloseDoor,
  HideTrap,
  RevealTrap,
  EnableDoodad,
  DisableDoodad,
  WarpIn,
  Medic,
  MedicHeal,
  HealMove,
  MedicHoldPosition,
  MedicHealToIdle,
  CastRestoration,
  CastDisruptionWeb,
  CastMindControl,
  DarkArchonMeld,
  CastFeedback,
  CastOpticalFlare,
  CastMaelstrom,
  JunkYardDog,
  Fatal,
  None,
  Unknown,
  MAX
}

Detailed Description

Enumeration of unit orders.

See also
Order

Enumeration Type Documentation

Enumeration of unit orders.

See also
Order
Enumerator
Die 

Value of 0 [0x0].

See BWAPI::Orders::Die.

Stop 

Value of 1 [0x1].

See BWAPI::Orders::Stop.

Guard 

Value of 2 [0x2].

See BWAPI::Orders::Guard.

PlayerGuard 

Value of 3 [0x3].

See BWAPI::Orders::PlayerGuard.

TurretGuard 

Value of 4 [0x4].

See BWAPI::Orders::TurretGuard.

BunkerGuard 

Value of 5 [0x5].

See BWAPI::Orders::BunkerGuard.

Move 

Value of 6 [0x6].

See BWAPI::Orders::Move.

ReaverStop 
Attack1 
Attack2 
AttackUnit 

Value of 10 [0xa].

See BWAPI::Orders::AttackUnit.

AttackFixedRange 
AttackTile 

Value of 12 [0xc].

See BWAPI::Orders::AttackTile.

Hover 

Value of 13 [0xd].

See BWAPI::Orders::Hover.

AttackMove 

Value of 14 [0xe].

See BWAPI::Orders::AttackMove.

InfestedCommandCenter 

Value of 15 [0xf].

See BWAPI::Orders::InfestedCommandCenter.

UnusedNothing 

Value of 16 [0x10].

See BWAPI::Orders::UnusedNothing.

UnusedPowerup 

Value of 17 [0x11].

See BWAPI::Orders::UnusedPowerup.

TowerGuard 

Value of 18 [0x12].

See BWAPI::Orders::TowerGuard.

TowerAttack 
VultureMine 

Value of 20 [0x14].

See BWAPI::Orders::VultureMine.

StayInRange 
TurretAttack 
Nothing 

Value of 23 [0x17].

See BWAPI::Orders::Nothing.

Unused_24 
DroneStartBuild 
DroneBuild 
CastInfestation 

Value of 27 [0x1b].

See BWAPI::Orders::CastInfestation.

MoveToInfest 
InfestingCommandCenter 

Value of 29 [0x1d].

See BWAPI::Orders::InfestingCommandCenter.

PlaceBuilding 

Value of 30 [0x1e].

See BWAPI::Orders::PlaceBuilding.

PlaceProtossBuilding 
CreateProtossBuilding 

Value of 32 [0x20].

See BWAPI::Orders::CreateProtossBuilding.

ConstructingBuilding 

Value of 33 [0x21].

See BWAPI::Orders::ConstructingBuilding.

Repair 

Value of 34 [0x22].

See BWAPI::Orders::Repair.

MoveToRepair 
PlaceAddon 

Value of 36 [0x24].

See BWAPI::Orders::PlaceAddon.

BuildAddon 

Value of 37 [0x25].

See BWAPI::Orders::BuildAddon.

Train 

Value of 38 [0x26].

See BWAPI::Orders::Train.

RallyPointUnit 

Value of 39 [0x27].

See BWAPI::Orders::RallyPointUnit.

RallyPointTile 

Value of 40 [0x28].

See BWAPI::Orders::RallyPointTile.

ZergBirth 

Value of 41 [0x29].

See BWAPI::Orders::ZergBirth.

ZergUnitMorph 

Value of 42 [0x2a].

See BWAPI::Orders::ZergUnitMorph.

ZergBuildingMorph 

Value of 43 [0x2b].

See BWAPI::Orders::ZergBuildingMorph.

IncompleteBuilding 

Value of 44 [0x2c].

See BWAPI::Orders::IncompleteBuilding.

IncompleteMorphing 
BuildNydusExit 

Value of 46 [0x2e].

See BWAPI::Orders::BuildNydusExit.

EnterNydusCanal 

Value of 47 [0x2f].

See BWAPI::Orders::EnterNydusCanal.

IncompleteWarping 
Follow 

Value of 49 [0x31].

See BWAPI::Orders::Follow.

Carrier 

Value of 50 [0x32].

See BWAPI::Orders::Carrier.

ReaverCarrierMove 

Value of 51 [0x33].

See BWAPI::Orders::ReaverCarrierMove.

CarrierStop 
CarrierAttack 
CarrierMoveToAttack 
CarrierIgnore2 

Value of 55 [0x37].

See BWAPI::Orders::CarrierIgnore2.

CarrierFight 
CarrierHoldPosition 
Reaver 

Value of 58 [0x3a].

See BWAPI::Orders::Reaver.

ReaverAttack 
ReaverMoveToAttack 
ReaverFight 
ReaverHoldPosition 
TrainFighter 

Value of 63 [0x3f].

See BWAPI::Orders::TrainFighter.

InterceptorAttack 

Value of 64 [0x40].

See BWAPI::Orders::InterceptorAttack.

ScarabAttack 

Value of 65 [0x41].

See BWAPI::Orders::ScarabAttack.

RechargeShieldsUnit 

Value of 66 [0x42].

See BWAPI::Orders::RechargeShieldsUnit.

RechargeShieldsBattery 

Value of 67 [0x43].

See BWAPI::Orders::RechargeShieldsBattery.

ShieldBattery 

Value of 68 [0x44].

See BWAPI::Orders::ShieldBattery.

InterceptorReturn 

Value of 69 [0x45].

See BWAPI::Orders::InterceptorReturn.

DroneLand 
BuildingLand 

Value of 71 [0x47].

See BWAPI::Orders::BuildingLand.

BuildingLiftOff 

Value of 72 [0x48].

See BWAPI::Orders::BuildingLiftOff.

DroneLiftOff 

Value of 73 [0x49].

See BWAPI::Orders::DroneLiftOff.

LiftingOff 

Value of 74 [0x4a].

See BWAPI::Orders::LiftingOff.

ResearchTech 

Value of 75 [0x4b].

See BWAPI::Orders::ResearchTech.

Upgrade 

Value of 76 [0x4c].

See BWAPI::Orders::Upgrade.

Larva 

Value of 77 [0x4d].

See BWAPI::Orders::Larva.

SpawningLarva 

Value of 78 [0x4e].

See BWAPI::Orders::SpawningLarva.

Harvest1 

Value of 79 [0x4f].

See BWAPI::Orders::Harvest1.

Harvest2 

Value of 80 [0x50].

See BWAPI::Orders::Harvest2.

MoveToGas 

Value of 81 [0x51].

See BWAPI::Orders::MoveToGas.

WaitForGas 

Value of 82 [0x52].

See BWAPI::Orders::WaitForGas.

HarvestGas 

Value of 83 [0x53].

See BWAPI::Orders::HarvestGas.

ReturnGas 

Value of 84 [0x54].

See BWAPI::Orders::ReturnGas.

MoveToMinerals 

Value of 85 [0x55].

See BWAPI::Orders::MoveToMinerals.

WaitForMinerals 

Value of 86 [0x56].

See BWAPI::Orders::WaitForMinerals.

MiningMinerals 

Value of 87 [0x57].

See BWAPI::Orders::MiningMinerals.

Harvest3 

Value of 88 [0x58].

See BWAPI::Orders::Harvest3.

Harvest4 

Value of 89 [0x59].

See BWAPI::Orders::Harvest4.

ReturnMinerals 

Value of 90 [0x5a].

See BWAPI::Orders::ReturnMinerals.

Interrupted 

Value of 91 [0x5b].

See BWAPI::Orders::Interrupted.

EnterTransport 

Value of 92 [0x5c].

See BWAPI::Orders::EnterTransport.

PickupIdle 

Value of 93 [0x5d].

See BWAPI::Orders::PickupIdle.

PickupTransport 

Value of 94 [0x5e].

See BWAPI::Orders::PickupTransport.

PickupBunker 

Value of 95 [0x5f].

See BWAPI::Orders::PickupBunker.

Pickup4 

Value of 96 [0x60].

See BWAPI::Orders::Pickup4.

PowerupIdle 

Value of 97 [0x61].

See BWAPI::Orders::PowerupIdle.

Sieging 

Value of 98 [0x62].

See BWAPI::Orders::Sieging.

Unsieging 

Value of 99 [0x63].

See BWAPI::Orders::Unsieging.

WatchTarget 
InitCreepGrowth 

Value of 101 [0x65].

See BWAPI::Orders::InitCreepGrowth.

SpreadCreep 

Value of 102 [0x66].

See BWAPI::Orders::SpreadCreep.

StoppingCreepGrowth 

Value of 103 [0x67].

See BWAPI::Orders::StoppingCreepGrowth.

GuardianAspect 

Value of 104 [0x68].

See BWAPI::Orders::GuardianAspect.

ArchonWarp 

Value of 105 [0x69].

See BWAPI::Orders::ArchonWarp.

CompletingArchonSummon 

Value of 106 [0x6a].

See BWAPI::Orders::CompletingArchonSummon.

HoldPosition 

Value of 107 [0x6b].

See BWAPI::Orders::HoldPosition.

QueenHoldPosition 
Cloak 

Value of 109 [0x6d].

See BWAPI::Orders::Cloak.

Decloak 

Value of 110 [0x6e].

See BWAPI::Orders::Decloak.

Unload 

Value of 111 [0x6f].

See BWAPI::Orders::Unload.

MoveUnload 

Value of 112 [0x70].

See BWAPI::Orders::MoveUnload.

FireYamatoGun 

Value of 113 [0x71].

See BWAPI::Orders::FireYamatoGun.

MoveToFireYamatoGun 
CastLockdown 

Value of 115 [0x73].

See BWAPI::Orders::CastLockdown.

Burrowing 

Value of 116 [0x74].

See BWAPI::Orders::Burrowing.

Burrowed 

Value of 117 [0x75].

See BWAPI::Orders::Burrowed.

Unburrowing 

Value of 118 [0x76].

See BWAPI::Orders::Unburrowing.

CastDarkSwarm 

Value of 119 [0x77].

See BWAPI::Orders::CastDarkSwarm.

CastParasite 

Value of 120 [0x78].

See BWAPI::Orders::CastParasite.

CastSpawnBroodlings 

Value of 121 [0x79].

See BWAPI::Orders::CastSpawnBroodlings.

CastEMPShockwave 

Value of 122 [0x7a].

See BWAPI::Orders::CastEMPShockwave.

NukeWait 

Value of 123 [0x7b].

See BWAPI::Orders::NukeWait.

NukeTrain 

Value of 124 [0x7c].

See BWAPI::Orders::NukeTrain.

NukeLaunch 

Value of 125 [0x7d].

See BWAPI::Orders::NukeLaunch.

NukePaint 

Value of 126 [0x7e].

See BWAPI::Orders::NukePaint.

NukeUnit 

Value of 127 [0x7f].

See BWAPI::Orders::NukeUnit.

CastNuclearStrike 

Value of 128 [0x80].

See BWAPI::Orders::CastNuclearStrike.

NukeTrack 

Value of 129 [0x81].

See BWAPI::Orders::NukeTrack.

InitializeArbiter 
CloakNearbyUnits 

Value of 131 [0x83].

See BWAPI::Orders::CloakNearbyUnits.

PlaceMine 

Value of 132 [0x84].

See BWAPI::Orders::PlaceMine.

RightClickAction 

Value of 133 [0x85].

See BWAPI::Orders::RightClickAction.

SuicideUnit 
SuicideLocation 
SuicideHoldPosition 
CastRecall 

Value of 137 [0x89].

See BWAPI::Orders::CastRecall.

Teleport 

Value of 138 [0x8a].

See BWAPI::Orders::Teleport.

CastScannerSweep 

Value of 139 [0x8b].

See BWAPI::Orders::CastScannerSweep.

Scanner 

Value of 140 [0x8c].

See BWAPI::Orders::Scanner.

CastDefensiveMatrix 

Value of 141 [0x8d].

See BWAPI::Orders::CastDefensiveMatrix.

CastPsionicStorm 

Value of 142 [0x8e].

See BWAPI::Orders::CastPsionicStorm.

CastIrradiate 

Value of 143 [0x8f].

See BWAPI::Orders::CastIrradiate.

CastPlague 

Value of 144 [0x90].

See BWAPI::Orders::CastPlague.

CastConsume 

Value of 145 [0x91].

See BWAPI::Orders::CastConsume.

CastEnsnare 

Value of 146 [0x92].

See BWAPI::Orders::CastEnsnare.

CastStasisField 

Value of 147 [0x93].

See BWAPI::Orders::CastStasisField.

CastHallucination 

Value of 148 [0x94].

See BWAPI::Orders::CastHallucination.

Hallucination2 

Value of 149 [0x95].

See BWAPI::Orders::Hallucination2.

ResetCollision 

Value of 150 [0x96].

See BWAPI::Orders::ResetCollision.

ResetHarvestCollision 
Patrol 

Value of 152 [0x98].

See BWAPI::Orders::Patrol.

CTFCOPInit 

Value of 153 [0x99].

See BWAPI::Orders::CTFCOPInit.

CTFCOPStarted 

Value of 154 [0x9a].

See BWAPI::Orders::CTFCOPStarted.

CTFCOP2 

Value of 155 [0x9b].

See BWAPI::Orders::CTFCOP2.

ComputerAI 

Value of 156 [0x9c].

See BWAPI::Orders::ComputerAI.

AtkMoveEP 

Value of 157 [0x9d].

See BWAPI::Orders::AtkMoveEP.

HarassMove 

Value of 158 [0x9e].

See BWAPI::Orders::HarassMove.

AIPatrol 

Value of 159 [0x9f].

See BWAPI::Orders::AIPatrol.

GuardPost 

Value of 160 [0xa0].

See BWAPI::Orders::GuardPost.

RescuePassive 

Value of 161 [0xa1].

See BWAPI::Orders::RescuePassive.

Neutral 

Value of 162 [0xa2].

See BWAPI::Orders::Neutral.

ComputerReturn 

Value of 163 [0xa3].

See BWAPI::Orders::ComputerReturn.

InitializePsiProvider 
SelfDestructing 

Value of 165 [0xa5].

See BWAPI::Orders::SelfDestructing.

Critter 

Value of 166 [0xa6].

See BWAPI::Orders::Critter.

HiddenGun 

Value of 167 [0xa7].

See BWAPI::Orders::HiddenGun.

OpenDoor 

Value of 168 [0xa8].

See BWAPI::Orders::OpenDoor.

CloseDoor 

Value of 169 [0xa9].

See BWAPI::Orders::CloseDoor.

HideTrap 

Value of 170 [0xaa].

See BWAPI::Orders::HideTrap.

RevealTrap 

Value of 171 [0xab].

See BWAPI::Orders::RevealTrap.

EnableDoodad 

Value of 172 [0xac].

See BWAPI::Orders::EnableDoodad.

DisableDoodad 

Value of 173 [0xad].

See BWAPI::Orders::DisableDoodad.

WarpIn 

Value of 174 [0xae].

See BWAPI::Orders::WarpIn.

Medic 

Value of 175 [0xaf].

See BWAPI::Orders::Medic.

MedicHeal 

Value of 176 [0xb0].

See BWAPI::Orders::MedicHeal.

HealMove 

Value of 177 [0xb1].

See BWAPI::Orders::HealMove.

MedicHoldPosition 
MedicHealToIdle 

Value of 179 [0xb3].

See BWAPI::Orders::MedicHealToIdle.

CastRestoration 

Value of 180 [0xb4].

See BWAPI::Orders::CastRestoration.

CastDisruptionWeb 

Value of 181 [0xb5].

See BWAPI::Orders::CastDisruptionWeb.

CastMindControl 

Value of 182 [0xb6].

See BWAPI::Orders::CastMindControl.

DarkArchonMeld 

Value of 183 [0xb7].

See BWAPI::Orders::DarkArchonMeld.

CastFeedback 

Value of 184 [0xb8].

See BWAPI::Orders::CastFeedback.

CastOpticalFlare 

Value of 185 [0xb9].

See BWAPI::Orders::CastOpticalFlare.

CastMaelstrom 

Value of 186 [0xba].

See BWAPI::Orders::CastMaelstrom.

JunkYardDog 

Value of 187 [0xbb].

See BWAPI::Orders::JunkYardDog.

Fatal 

Value of 188 [0xbc].

See BWAPI::Orders::Fatal.

None 
Unknown 
MAX