Order (jbwapi 2.1.0 API)

java.lang.Object
- java.lang.Enum<Order>
- - bwapi.Order

All Implemented Interfaces:

Serializable, Comparable<Order>
```
public enum Order
extends Enum<Order>
```
An Order (Order type) represents a Unit's current action and can be retrieved with Unit.getOrder().
It can also be used to identify the current state of the unit during command execution (gathering minerals can consist of MoveToMinerals, WaitForMinerals, MiningMinerals, etc.).

Enum Constant Summary

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

Field Summary

Fields
Modifier and Type Field and Description

int id

Fields
Modifier and Type	Field and Description
`int`	`id`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Order`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Order[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Die
```
public static final Order Die
```

Stop
```
public static final Order Stop
```

Guard
```
public static final Order Guard
```

PlayerGuard
```
public static final Order PlayerGuard
```

TurretGuard
```
public static final Order TurretGuard
```

BunkerGuard
```
public static final Order BunkerGuard
```

Move
```
public static final Order Move
```

ReaverStop
```
public static final Order ReaverStop
```

Attack1
```
public static final Order Attack1
```

Attack2
```
public static final Order Attack2
```

AttackUnit
```
public static final Order AttackUnit
```

AttackFixedRange

public static final Order AttackFixedRange

AttackTile
```
public static final Order AttackTile
```

Hover
```
public static final Order Hover
```

AttackMove
```
public static final Order AttackMove
```

InfestedCommandCenter

public static final Order InfestedCommandCenter

UnusedNothing

public static final Order UnusedNothing

UnusedPowerup

public static final Order UnusedPowerup

TowerGuard
```
public static final Order TowerGuard
```

TowerAttack
```
public static final Order TowerAttack
```

VultureMine
```
public static final Order VultureMine
```

StayInRange
```
public static final Order StayInRange
```

TurretAttack
```
public static final Order TurretAttack
```

Nothing
```
public static final Order Nothing
```

Unused_24
```
public static final Order Unused_24
```

DroneStartBuild

public static final Order DroneStartBuild

DroneBuild
```
public static final Order DroneBuild
```

CastInfestation

public static final Order CastInfestation

MoveToInfest
```
public static final Order MoveToInfest
```

InfestingCommandCenter

public static final Order InfestingCommandCenter

PlaceBuilding

public static final Order PlaceBuilding

PlaceProtossBuilding

public static final Order PlaceProtossBuilding

CreateProtossBuilding

public static final Order CreateProtossBuilding

ConstructingBuilding

public static final Order ConstructingBuilding

Repair
```
public static final Order Repair
```

MoveToRepair
```
public static final Order MoveToRepair
```

PlaceAddon
```
public static final Order PlaceAddon
```

BuildAddon
```
public static final Order BuildAddon
```

Train
```
public static final Order Train
```

RallyPointUnit

public static final Order RallyPointUnit

RallyPointTile

public static final Order RallyPointTile

ZergBirth
```
public static final Order ZergBirth
```

ZergUnitMorph

public static final Order ZergUnitMorph

ZergBuildingMorph

public static final Order ZergBuildingMorph

IncompleteBuilding

public static final Order IncompleteBuilding

IncompleteMorphing

public static final Order IncompleteMorphing

BuildNydusExit

public static final Order BuildNydusExit

EnterNydusCanal

public static final Order EnterNydusCanal

IncompleteWarping

public static final Order IncompleteWarping

Follow
```
public static final Order Follow
```

Carrier
```
public static final Order Carrier
```

ReaverCarrierMove

public static final Order ReaverCarrierMove

CarrierStop
```
public static final Order CarrierStop
```

CarrierAttack

public static final Order CarrierAttack

CarrierMoveToAttack

public static final Order CarrierMoveToAttack

CarrierIgnore2

public static final Order CarrierIgnore2

CarrierFight
```
public static final Order CarrierFight
```

CarrierHoldPosition

public static final Order CarrierHoldPosition

Reaver
```
public static final Order Reaver
```

ReaverAttack
```
public static final Order ReaverAttack
```

ReaverMoveToAttack

public static final Order ReaverMoveToAttack

ReaverFight
```
public static final Order ReaverFight
```

ReaverHoldPosition

public static final Order ReaverHoldPosition

TrainFighter
```
public static final Order TrainFighter
```

InterceptorAttack

public static final Order InterceptorAttack

ScarabAttack
```
public static final Order ScarabAttack
```

RechargeShieldsUnit

public static final Order RechargeShieldsUnit

RechargeShieldsBattery

public static final Order RechargeShieldsBattery

ShieldBattery

public static final Order ShieldBattery

InterceptorReturn

public static final Order InterceptorReturn

DroneLand
```
public static final Order DroneLand
```

BuildingLand
```
public static final Order BuildingLand
```

BuildingLiftOff

public static final Order BuildingLiftOff

DroneLiftOff
```
public static final Order DroneLiftOff
```

LiftingOff
```
public static final Order LiftingOff
```

ResearchTech
```
public static final Order ResearchTech
```

Upgrade
```
public static final Order Upgrade
```

Larva
```
public static final Order Larva
```

SpawningLarva

public static final Order SpawningLarva

Harvest1
```
public static final Order Harvest1
```

Harvest2
```
public static final Order Harvest2
```

MoveToGas
```
public static final Order MoveToGas
```

WaitForGas
```
public static final Order WaitForGas
```

HarvestGas
```
public static final Order HarvestGas
```

ReturnGas
```
public static final Order ReturnGas
```

MoveToMinerals

public static final Order MoveToMinerals

WaitForMinerals

public static final Order WaitForMinerals

MiningMinerals

public static final Order MiningMinerals

Harvest3
```
public static final Order Harvest3
```

Harvest4
```
public static final Order Harvest4
```

ReturnMinerals

public static final Order ReturnMinerals

Interrupted
```
public static final Order Interrupted
```

EnterTransport

public static final Order EnterTransport

PickupIdle
```
public static final Order PickupIdle
```

PickupTransport

public static final Order PickupTransport

PickupBunker
```
public static final Order PickupBunker
```

Pickup4
```
public static final Order Pickup4
```

PowerupIdle
```
public static final Order PowerupIdle
```

Sieging
```
public static final Order Sieging
```

Unsieging
```
public static final Order Unsieging
```

WatchTarget
```
public static final Order WatchTarget
```

InitCreepGrowth

public static final Order InitCreepGrowth

SpreadCreep
```
public static final Order SpreadCreep
```

StoppingCreepGrowth

public static final Order StoppingCreepGrowth

GuardianAspect

public static final Order GuardianAspect

ArchonWarp
```
public static final Order ArchonWarp
```

CompletingArchonSummon

public static final Order CompletingArchonSummon

HoldPosition
```
public static final Order HoldPosition
```

QueenHoldPosition

public static final Order QueenHoldPosition

Cloak
```
public static final Order Cloak
```

Decloak
```
public static final Order Decloak
```

Unload
```
public static final Order Unload
```

MoveUnload
```
public static final Order MoveUnload
```

FireYamatoGun

public static final Order FireYamatoGun

MoveToFireYamatoGun

public static final Order MoveToFireYamatoGun

CastLockdown
```
public static final Order CastLockdown
```

Burrowing
```
public static final Order Burrowing
```

Burrowed
```
public static final Order Burrowed
```

Unburrowing
```
public static final Order Unburrowing
```

CastDarkSwarm

public static final Order CastDarkSwarm

CastParasite
```
public static final Order CastParasite
```

CastSpawnBroodlings

public static final Order CastSpawnBroodlings

CastEMPShockwave

public static final Order CastEMPShockwave

NukeWait
```
public static final Order NukeWait
```

NukeTrain
```
public static final Order NukeTrain
```

NukeLaunch
```
public static final Order NukeLaunch
```

NukePaint
```
public static final Order NukePaint
```

NukeUnit
```
public static final Order NukeUnit
```

CastNuclearStrike

public static final Order CastNuclearStrike

NukeTrack
```
public static final Order NukeTrack
```

InitializeArbiter

public static final Order InitializeArbiter

CloakNearbyUnits

public static final Order CloakNearbyUnits

PlaceMine
```
public static final Order PlaceMine
```

RightClickAction

public static final Order RightClickAction

SuicideUnit
```
public static final Order SuicideUnit
```

SuicideLocation

public static final Order SuicideLocation

SuicideHoldPosition

public static final Order SuicideHoldPosition

CastRecall
```
public static final Order CastRecall
```

Teleport
```
public static final Order Teleport
```

CastScannerSweep

public static final Order CastScannerSweep

Scanner
```
public static final Order Scanner
```

CastDefensiveMatrix

public static final Order CastDefensiveMatrix

CastPsionicStorm

public static final Order CastPsionicStorm

CastIrradiate

public static final Order CastIrradiate

CastPlague
```
public static final Order CastPlague
```

CastConsume
```
public static final Order CastConsume
```

CastEnsnare
```
public static final Order CastEnsnare
```

CastStasisField

public static final Order CastStasisField

CastHallucination

public static final Order CastHallucination

Hallucination2

public static final Order Hallucination2

ResetCollision

public static final Order ResetCollision

ResetHarvestCollision

public static final Order ResetHarvestCollision

Patrol
```
public static final Order Patrol
```

CTFCOPInit
```
public static final Order CTFCOPInit
```

CTFCOPStarted

public static final Order CTFCOPStarted

CTFCOP2
```
public static final Order CTFCOP2
```

ComputerAI
```
public static final Order ComputerAI
```

AtkMoveEP
```
public static final Order AtkMoveEP
```

HarassMove
```
public static final Order HarassMove
```

AIPatrol
```
public static final Order AIPatrol
```

GuardPost
```
public static final Order GuardPost
```

RescuePassive

public static final Order RescuePassive

Neutral
```
public static final Order Neutral
```

ComputerReturn

public static final Order ComputerReturn

InitializePsiProvider

public static final Order InitializePsiProvider

SelfDestructing

public static final Order SelfDestructing

Critter
```
public static final Order Critter
```

HiddenGun
```
public static final Order HiddenGun
```

OpenDoor
```
public static final Order OpenDoor
```

CloseDoor
```
public static final Order CloseDoor
```

HideTrap
```
public static final Order HideTrap
```

RevealTrap
```
public static final Order RevealTrap
```

EnableDoodad
```
public static final Order EnableDoodad
```

DisableDoodad

public static final Order DisableDoodad

WarpIn
```
public static final Order WarpIn
```

Medic
```
public static final Order Medic
```

MedicHeal
```
public static final Order MedicHeal
```

HealMove
```
public static final Order HealMove
```

MedicHoldPosition

public static final Order MedicHoldPosition

MedicHealToIdle

public static final Order MedicHealToIdle

CastRestoration

public static final Order CastRestoration

CastDisruptionWeb

public static final Order CastDisruptionWeb

CastMindControl

public static final Order CastMindControl

DarkArchonMeld

public static final Order DarkArchonMeld

CastFeedback
```
public static final Order CastFeedback
```

CastOpticalFlare

public static final Order CastOpticalFlare

CastMaelstrom

public static final Order CastMaelstrom

JunkYardDog
```
public static final Order JunkYardDog
```

Fatal
```
public static final Order Fatal
```

None
```
public static final Order None
```

Unknown
```
public static final Order Unknown
```

Field Detail
- id
```
public final int id
```

Method Detail
- values
```
public static Order[] values()
```
  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Order c : Order.values())
    System.out.println(c);
```
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Order valueOf(String name)
```
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null

Enum Order

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

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