Orders¶

Module containing unit orders.

See also

Functions¶

static BWAPI.Orders.allOrders() → set¶

Retrieves a set of all Orders.

Returns:	Set of all Orders.
Return type:	`Orderset`

Constants¶

All constants are instances of the Order class

BWAPI.Orders.Die¶

BWAPI.Orders.Stop¶

BWAPI.Orders.Guard¶

BWAPI.Orders.PlayerGuard¶

BWAPI.Orders.TurretGuard¶

BWAPI.Orders.BunkerGuard¶

BWAPI.Orders.Move¶

BWAPI.Orders.AttackUnit¶

BWAPI.Orders.AttackTile¶

BWAPI.Orders.Hover¶

BWAPI.Orders.AttackMove¶

BWAPI.Orders.InfestedCommandCenter¶

BWAPI.Orders.UnusedNothing¶

BWAPI.Orders.UnusedPowerup¶

BWAPI.Orders.TowerGuard¶

BWAPI.Orders.VultureMine¶

BWAPI.Orders.Nothing¶

BWAPI.Orders.CastInfestation¶

BWAPI.Orders.InfestingCommandCenter¶

BWAPI.Orders.PlaceBuilding¶

BWAPI.Orders.CreateProtossBuilding¶

BWAPI.Orders.ConstructingBuilding¶

BWAPI.Orders.Repair¶

BWAPI.Orders.PlaceAddon¶

BWAPI.Orders.BuildAddon¶

BWAPI.Orders.Train¶

BWAPI.Orders.RallyPointUnit¶

BWAPI.Orders.RallyPointTile¶

BWAPI.Orders.ZergBirth¶

BWAPI.Orders.ZergUnitMorph¶

BWAPI.Orders.ZergBuildingMorph¶

BWAPI.Orders.IncompleteBuilding¶

BWAPI.Orders.BuildNydusExit¶

BWAPI.Orders.EnterNydusCanal¶

BWAPI.Orders.Follow¶

BWAPI.Orders.Carrier¶

BWAPI.Orders.ReaverCarrierMove¶

BWAPI.Orders.CarrierIgnore2¶

BWAPI.Orders.Reaver¶

BWAPI.Orders.TrainFighter¶

BWAPI.Orders.InterceptorAttack¶

BWAPI.Orders.ScarabAttack¶

BWAPI.Orders.RechargeShieldsUnit¶

BWAPI.Orders.RechargeShieldsBattery¶

BWAPI.Orders.ShieldBattery¶

BWAPI.Orders.InterceptorReturn¶

BWAPI.Orders.BuildingLand¶

BWAPI.Orders.BuildingLiftOff¶

BWAPI.Orders.DroneLiftOff¶

BWAPI.Orders.LiftingOff¶

BWAPI.Orders.ResearchTech¶

BWAPI.Orders.Upgrade¶

BWAPI.Orders.Larva¶

BWAPI.Orders.SpawningLarva¶

BWAPI.Orders.Harvest1¶

BWAPI.Orders.Harvest2¶

BWAPI.Orders.MoveToGas¶

BWAPI.Orders.WaitForGas¶

BWAPI.Orders.HarvestGas¶

BWAPI.Orders.ReturnGas¶

BWAPI.Orders.MoveToMinerals¶

BWAPI.Orders.WaitForMinerals¶

BWAPI.Orders.MiningMinerals¶

BWAPI.Orders.Harvest3¶

BWAPI.Orders.Harvest4¶

BWAPI.Orders.ReturnMinerals¶

BWAPI.Orders.Interrupted¶

BWAPI.Orders.EnterTransport¶

BWAPI.Orders.PickupIdle¶

BWAPI.Orders.PickupTransport¶

BWAPI.Orders.PickupBunker¶

BWAPI.Orders.Pickup4¶

BWAPI.Orders.PowerupIdle¶

BWAPI.Orders.Sieging¶

BWAPI.Orders.Unsieging¶

BWAPI.Orders.InitCreepGrowth¶

BWAPI.Orders.SpreadCreep¶

BWAPI.Orders.StoppingCreepGrowth¶

BWAPI.Orders.GuardianAspect¶

BWAPI.Orders.ArchonWarp¶

BWAPI.Orders.CompletingArchonSummon¶

BWAPI.Orders.HoldPosition¶

BWAPI.Orders.Cloak¶

BWAPI.Orders.Decloak¶

BWAPI.Orders.Unload¶

BWAPI.Orders.MoveUnload¶

BWAPI.Orders.FireYamatoGun¶

BWAPI.Orders.CastLockdown¶

BWAPI.Orders.Burrowing¶

BWAPI.Orders.Burrowed¶

BWAPI.Orders.Unburrowing¶

BWAPI.Orders.CastDarkSwarm¶

BWAPI.Orders.CastParasite¶

BWAPI.Orders.CastSpawnBroodlings¶

BWAPI.Orders.CastEMPShockwave¶

BWAPI.Orders.NukeWait¶

BWAPI.Orders.NukeTrain¶

BWAPI.Orders.NukeLaunch¶

BWAPI.Orders.NukePaint¶

BWAPI.Orders.NukeUnit¶

BWAPI.Orders.CastNuclearStrike¶

BWAPI.Orders.NukeTrack¶

BWAPI.Orders.CloakNearbyUnits¶

BWAPI.Orders.PlaceMine¶

BWAPI.Orders.RightClickAction¶

BWAPI.Orders.CastRecall¶

BWAPI.Orders.Teleport¶

BWAPI.Orders.CastScannerSweep¶

BWAPI.Orders.Scanner¶

BWAPI.Orders.CastDefensiveMatrix¶

BWAPI.Orders.CastPsionicStorm¶

BWAPI.Orders.CastIrradiate¶

BWAPI.Orders.CastPlague¶

BWAPI.Orders.CastConsume¶

BWAPI.Orders.CastEnsnare¶

BWAPI.Orders.CastStasisField¶

BWAPI.Orders.CastHallucination¶

BWAPI.Orders.Hallucination2¶

BWAPI.Orders.ResetCollision¶

BWAPI.Orders.Patrol¶

BWAPI.Orders.CTFCOPInit¶

BWAPI.Orders.CTFCOPStarted¶

BWAPI.Orders.CTFCOP2¶

BWAPI.Orders.ComputerAI¶

BWAPI.Orders.AtkMoveEP¶

BWAPI.Orders.HarassMove¶

BWAPI.Orders.AIPatrol¶

BWAPI.Orders.GuardPost¶

BWAPI.Orders.RescuePassive¶

BWAPI.Orders.Neutral¶

BWAPI.Orders.ComputerReturn¶

BWAPI.Orders.SelfDestructing¶

BWAPI.Orders.Critter¶

BWAPI.Orders.HiddenGun¶

BWAPI.Orders.OpenDoor¶

BWAPI.Orders.CloseDoor¶

BWAPI.Orders.HideTrap¶

BWAPI.Orders.RevealTrap¶

BWAPI.Orders.EnableDoodad¶

BWAPI.Orders.DisableDoodad¶

BWAPI.Orders.WarpIn¶

BWAPI.Orders.Medic¶

BWAPI.Orders.MedicHeal¶

BWAPI.Orders.HealMove¶

BWAPI.Orders.MedicHealToIdle¶

BWAPI.Orders.CastRestoration¶

BWAPI.Orders.CastDisruptionWeb¶

BWAPI.Orders.CastMindControl¶

BWAPI.Orders.DarkArchonMeld¶

BWAPI.Orders.CastFeedback¶

BWAPI.Orders.CastOpticalFlare¶

BWAPI.Orders.CastMaelstrom¶

BWAPI.Orders.JunkYardDog¶

BWAPI.Orders.Fatal¶

BWAPI.Orders.None¶

BWAPI.Orders.Unknown¶

Enum¶

Enumeration of unit orders.

Important

Enum values rarely need to be used in Lua.

BWAPI.Orders.Enum.Die¶: Value of 0.

BWAPI.Orders.Enum.Stop¶: Value of 1.

BWAPI.Orders.Enum.Guard¶: Value of 2.

BWAPI.Orders.Enum.PlayerGuard¶: Value of 3.

BWAPI.Orders.Enum.TurretGuard¶: Value of 4.

BWAPI.Orders.Enum.BunkerGuard¶: Value of 5.

BWAPI.Orders.Enum.Move¶: Value of 6.

BWAPI.Orders.Enum.ReaverStop¶: Value of 7.

BWAPI.Orders.Enum.Attack1¶: Value of 8.

BWAPI.Orders.Enum.Attack2¶: Value of 9.

BWAPI.Orders.Enum.AttackUnit¶: Value of 10.

BWAPI.Orders.Enum.AttackFixedRange¶: Value of 11.

BWAPI.Orders.Enum.AttackTile¶: Value of 12.

BWAPI.Orders.Enum.Hover¶: Value of 13.

BWAPI.Orders.Enum.AttackMove¶: Value of 14.

BWAPI.Orders.Enum.InfestedCommandCenter¶: Value of 15.

BWAPI.Orders.Enum.UnusedNothing¶: Value of 16.

BWAPI.Orders.Enum.UnusedPowerup¶: Value of 17.

BWAPI.Orders.Enum.TowerGuard¶: Value of 18.

BWAPI.Orders.Enum.TowerAttack¶: Value of 19.

BWAPI.Orders.Enum.VultureMine¶: Value of 20.

BWAPI.Orders.Enum.StayInRange¶: Value of 21.

BWAPI.Orders.Enum.TurretAttack¶: Value of 22.

BWAPI.Orders.Enum.Nothing¶: Value of 23.

BWAPI.Orders.Enum.Unused_24¶: Value of 24.

BWAPI.Orders.Enum.DroneStartBuild¶: Value of 25.

BWAPI.Orders.Enum.DroneBuild¶: Value of 26.

BWAPI.Orders.Enum.CastInfestation¶: Value of 27.

BWAPI.Orders.Enum.MoveToInfest¶: Value of 28.

BWAPI.Orders.Enum.InfestingCommandCenter¶: Value of 29.

BWAPI.Orders.Enum.PlaceBuilding¶: Value of 30.

BWAPI.Orders.Enum.PlaceProtossBuilding¶: Value of 31.

BWAPI.Orders.Enum.CreateProtossBuilding¶: Value of 32.

BWAPI.Orders.Enum.ConstructingBuilding¶: Value of 33.

BWAPI.Orders.Enum.Repair¶: Value of 34.

BWAPI.Orders.Enum.MoveToRepair¶: Value of 35.

BWAPI.Orders.Enum.PlaceAddon¶: Value of 36.

BWAPI.Orders.Enum.BuildAddon¶: Value of 37.

BWAPI.Orders.Enum.Train¶: Value of 38.

BWAPI.Orders.Enum.RallyPointUnit¶: Value of 39.

BWAPI.Orders.Enum.RallyPointTile¶: Value of 40.

BWAPI.Orders.Enum.ZergBirth¶: Value of 41.

BWAPI.Orders.Enum.ZergUnitMorph¶: Value of 42.

BWAPI.Orders.Enum.ZergBuildingMorph¶: Value of 43.

BWAPI.Orders.Enum.IncompleteBuilding¶: Value of 44.

BWAPI.Orders.Enum.IncompleteMorphing¶: Value of 45.

BWAPI.Orders.Enum.BuildNydusExit¶: Value of 46.

BWAPI.Orders.Enum.EnterNydusCanal¶: Value of 47.

BWAPI.Orders.Enum.IncompleteWarping¶: Value of 48.

BWAPI.Orders.Enum.Follow¶: Value of 49.

BWAPI.Orders.Enum.Carrier¶: Value of 50.

BWAPI.Orders.Enum.ReaverCarrierMove¶: Value of 51.

BWAPI.Orders.Enum.CarrierStop¶: Value of 52.

BWAPI.Orders.Enum.CarrierAttack¶: Value of 53.

BWAPI.Orders.Enum.CarrierMoveToAttack¶: Value of 54.

BWAPI.Orders.Enum.CarrierIgnore2¶: Value of 55.

BWAPI.Orders.Enum.CarrierFight¶: Value of 56.

BWAPI.Orders.Enum.CarrierHoldPosition¶: Value of 57.

BWAPI.Orders.Enum.Reaver¶: Value of 58.

BWAPI.Orders.Enum.ReaverAttack¶: Value of 59.

BWAPI.Orders.Enum.ReaverMoveToAttack¶: Value of 60.

BWAPI.Orders.Enum.ReaverFight¶: Value of 61.

BWAPI.Orders.Enum.ReaverHoldPosition¶: Value of 62.

BWAPI.Orders.Enum.TrainFighter¶: Value of 63.

BWAPI.Orders.Enum.InterceptorAttack¶: Value of 64.

BWAPI.Orders.Enum.ScarabAttack¶: Value of 65.

BWAPI.Orders.Enum.RechargeShieldsUnit¶: Value of 66.

BWAPI.Orders.Enum.RechargeShieldsBattery¶: Value of 67.

BWAPI.Orders.Enum.ShieldBattery¶: Value of 68.

BWAPI.Orders.Enum.InterceptorReturn¶: Value of 69.

BWAPI.Orders.Enum.DroneLand¶: Value of 70.

BWAPI.Orders.Enum.BuildingLand¶: Value of 71.

BWAPI.Orders.Enum.BuildingLiftOff¶: Value of 72.

BWAPI.Orders.Enum.DroneLiftOff¶: Value of 73.

BWAPI.Orders.Enum.LiftingOff¶: Value of 74.

BWAPI.Orders.Enum.ResearchTech¶: Value of 75.

BWAPI.Orders.Enum.Upgrade¶: Value of 76.

BWAPI.Orders.Enum.Larva¶: Value of 77.

BWAPI.Orders.Enum.SpawningLarva¶: Value of 78.

BWAPI.Orders.Enum.Harvest1¶: Value of 79.

BWAPI.Orders.Enum.Harvest2¶: Value of 80.

BWAPI.Orders.Enum.MoveToGas¶: Value of 81.

BWAPI.Orders.Enum.WaitForGas¶: Value of 82.

BWAPI.Orders.Enum.HarvestGas¶: Value of 83.

BWAPI.Orders.Enum.ReturnGas¶: Value of 84.

BWAPI.Orders.Enum.MoveToMinerals¶: Value of 85.

BWAPI.Orders.Enum.WaitForMinerals¶: Value of 86.

BWAPI.Orders.Enum.MiningMinerals¶: Value of 87.

BWAPI.Orders.Enum.Harvest3¶: Value of 88.

BWAPI.Orders.Enum.Harvest4¶: Value of 89.

BWAPI.Orders.Enum.ReturnMinerals¶: Value of 90.

BWAPI.Orders.Enum.Interrupted¶: Value of 91.

BWAPI.Orders.Enum.EnterTransport¶: Value of 92.

BWAPI.Orders.Enum.PickupIdle¶: Value of 93.

BWAPI.Orders.Enum.PickupTransport¶: Value of 94.

BWAPI.Orders.Enum.PickupBunker¶: Value of 95.

BWAPI.Orders.Enum.Pickup4¶: Value of 96.

BWAPI.Orders.Enum.PowerupIdle¶: Value of 97.

BWAPI.Orders.Enum.Sieging¶: Value of 98.

BWAPI.Orders.Enum.Unsieging¶: Value of 99.

BWAPI.Orders.Enum.WatchTarget¶: Value of 100.

BWAPI.Orders.Enum.InitCreepGrowth¶: Value of 101.

BWAPI.Orders.Enum.SpreadCreep¶: Value of 102.

BWAPI.Orders.Enum.StoppingCreepGrowth¶: Value of 103.

BWAPI.Orders.Enum.GuardianAspect¶: Value of 104.

BWAPI.Orders.Enum.ArchonWarp¶: Value of 105.

BWAPI.Orders.Enum.CompletingArchonSummon¶: Value of 106.

BWAPI.Orders.Enum.HoldPosition¶: Value of 107.

BWAPI.Orders.Enum.QueenHoldPosition¶: Value of 108.

BWAPI.Orders.Enum.Cloak¶: Value of 109.

BWAPI.Orders.Enum.Decloak¶: Value of 110.

BWAPI.Orders.Enum.Unload¶: Value of 111.

BWAPI.Orders.Enum.MoveUnload¶: Value of 112.

BWAPI.Orders.Enum.FireYamatoGun¶: Value of 113.

BWAPI.Orders.Enum.MoveToFireYamatoGun¶: Value of 114.

BWAPI.Orders.Enum.CastLockdown¶: Value of 115.

BWAPI.Orders.Enum.Burrowing¶: Value of 116.

BWAPI.Orders.Enum.Burrowed¶: Value of 117.

BWAPI.Orders.Enum.Unburrowing¶: Value of 118.

BWAPI.Orders.Enum.CastDarkSwarm¶: Value of 119.

BWAPI.Orders.Enum.CastParasite¶: Value of 120.

BWAPI.Orders.Enum.CastSpawnBroodlings¶: Value of 121.

BWAPI.Orders.Enum.CastEMPShockwave¶: Value of 122.

BWAPI.Orders.Enum.NukeWait¶: Value of 123.

BWAPI.Orders.Enum.NukeTrain¶: Value of 124.

BWAPI.Orders.Enum.NukeLaunch¶: Value of 125.

BWAPI.Orders.Enum.NukePaint¶: Value of 126.

BWAPI.Orders.Enum.NukeUnit¶: Value of 127.

BWAPI.Orders.Enum.CastNuclearStrike¶: Value of 128.

BWAPI.Orders.Enum.NukeTrack¶: Value of 129.

BWAPI.Orders.Enum.InitializeArbiter¶: Value of 130.

BWAPI.Orders.Enum.CloakNearbyUnits¶: Value of 131.

BWAPI.Orders.Enum.PlaceMine¶: Value of 132.

BWAPI.Orders.Enum.RightClickAction¶: Value of 133.

BWAPI.Orders.Enum.SuicideUnit¶: Value of 134.

BWAPI.Orders.Enum.SuicideLocation¶: Value of 135.

BWAPI.Orders.Enum.SuicideHoldPosition¶: Value of 136.

BWAPI.Orders.Enum.CastRecall¶: Value of 137.

BWAPI.Orders.Enum.Teleport¶: Value of 138.

BWAPI.Orders.Enum.CastScannerSweep¶: Value of 139.

BWAPI.Orders.Enum.Scanner¶: Value of 140.

BWAPI.Orders.Enum.CastDefensiveMatrix¶: Value of 141.

BWAPI.Orders.Enum.CastPsionicStorm¶: Value of 142.

BWAPI.Orders.Enum.CastIrradiate¶: Value of 143.

BWAPI.Orders.Enum.CastPlague¶: Value of 144.

BWAPI.Orders.Enum.CastConsume¶: Value of 145.

BWAPI.Orders.Enum.CastEnsnare¶: Value of 146.

BWAPI.Orders.Enum.CastStasisField¶: Value of 147.

BWAPI.Orders.Enum.CastHallucination¶: Value of 148.

BWAPI.Orders.Enum.Hallucination2¶: Value of 149.

BWAPI.Orders.Enum.ResetCollision¶: Value of 150.

BWAPI.Orders.Enum.ResetHarvestCollision¶: Value of 151.

BWAPI.Orders.Enum.Patrol¶: Value of 152.

BWAPI.Orders.Enum.CTFCOPInit¶: Value of 153.

BWAPI.Orders.Enum.CTFCOPStarted¶: Value of 154.

BWAPI.Orders.Enum.CTFCOP2¶: Value of 155.

BWAPI.Orders.Enum.ComputerAI¶: Value of 156.

BWAPI.Orders.Enum.AtkMoveEP¶: Value of 157.

BWAPI.Orders.Enum.HarassMove¶: Value of 158.

BWAPI.Orders.Enum.AIPatrol¶: Value of 159.

BWAPI.Orders.Enum.GuardPost¶: Value of 160.

BWAPI.Orders.Enum.RescuePassive¶: Value of 161.

BWAPI.Orders.Enum.Neutral¶: Value of 162.

BWAPI.Orders.Enum.ComputerReturn¶: Value of 163.

BWAPI.Orders.Enum.InitializePsiProvider¶: Value of 164.

BWAPI.Orders.Enum.SelfDestructing¶: Value of 165.

BWAPI.Orders.Enum.Critter¶: Value of 166.

BWAPI.Orders.Enum.HiddenGun¶: Value of 167.

BWAPI.Orders.Enum.OpenDoor¶: Value of 168.

BWAPI.Orders.Enum.CloseDoor¶: Value of 169.

BWAPI.Orders.Enum.HideTrap¶: Value of 170.

BWAPI.Orders.Enum.RevealTrap¶: Value of 171.

BWAPI.Orders.Enum.EnableDoodad¶: Value of 172.

BWAPI.Orders.Enum.DisableDoodad¶: Value of 173.

BWAPI.Orders.Enum.WarpIn¶: Value of 174.

BWAPI.Orders.Enum.Medic¶: Value of 175.

BWAPI.Orders.Enum.MedicHeal¶: Value of 176.

BWAPI.Orders.Enum.HealMove¶: Value of 177.

BWAPI.Orders.Enum.MedicHoldPosition¶: Value of 178.

BWAPI.Orders.Enum.MedicHealToIdle¶: Value of 179.

BWAPI.Orders.Enum.CastRestoration¶: Value of 180.

BWAPI.Orders.Enum.CastDisruptionWeb¶: Value of 181.

BWAPI.Orders.Enum.CastMindControl¶: Value of 182.

BWAPI.Orders.Enum.DarkArchonMeld¶: Value of 183.

BWAPI.Orders.Enum.CastFeedback¶: Value of 184.

BWAPI.Orders.Enum.CastOpticalFlare¶: Value of 185.

BWAPI.Orders.Enum.CastMaelstrom¶: Value of 186.

BWAPI.Orders.Enum.JunkYardDog¶: Value of 187.

BWAPI.Orders.Enum.Fatal¶: Value of 188.

BWAPI.Orders.Enum.None¶: Value of 189.

BWAPI.Orders.Enum.Unknown¶: Value of 190.

BWAPI.Orders.Enum.MAX¶: Value of 191.

Read the Docs v: latest

Versions: latest

Downloads: pdf; htmlzip; epub

On Read the Docs: Project Home; Builds

Free document hosting provided by Read the Docs.